Update README

esbmc · Jan 31, 2024 · 9fbc947 · 9fbc947
1 parent 96750f2
commit 9fbc947
Showing 1 changed file with 7 additions and 104 deletions.
diff --git a/README.md b/README.md
@@ -43,115 +43,15 @@ For full documentation, see the [ESBMC-AI Wiki](https://github.com/Yiannis128/es
 
 ## Initial Setup
 
-1. Install required Python modules: `pip3 install -dr requirements.txt`. Alternatively use `pipenv shell` to go into a virtual environment and run `pipenv lock -d` to install dependencies from the Pipfile.
-2. ESBMC-AI does not come with the original ESBMC software. In order to use ESBMC-AI you must download ESBMC. Download the [ESBMC](http://esbmc.org/) executable or build from [source](https://github.com/esbmc/esbmc).
-3. Once the ESBMC software is downloaded, open the `config.json` file, and edit the `esbmc_path` field to specify the location of ESBMC, it's recommended for development purposes to either install it globally or have it in the project root folder.
-4. Create a `.env` file using the provided `.env.example` as a template. **Make sure to insert your OpenAI API and Hugging Face key inside the `.env` file you just created!**
-5. Further, adjust `.env` settings as required.
-6. Further, adjust the `config.json` file as required. Be careful when editing AI model messages as incorrect messages can break the flow of the program, or introduce incorrect results. In general, it's recommended to leave those options alone.
-7. You can now run ESBMC-AI. See usage instructions below.
+See [Initial Setup Wiki Page](https://github.com/Yiannis128/esbmc-ai/wiki/Initial-Setup).
 
-### Additional
+## Configuration/Settings
 
-Make sure to install `gcc` and have `libc` installed, as some parts of ESBMC-AI use `libclang`.
-
-## Settings
-
-### .env
-
-The `.env` file contains the configuration of sensitive data. An example `.env.example` file is given as a template. It should be renamed into `.env` in order to be used by the program. The following settings are adjustable in the .env file:
-
-1. `OPENAI_API_KEY`: Your OpenAI API key.
-2. `HUGGINGFACE_API_KEY`: Your Hugging Face API key.
-3. `ESBMC_AI_CFG_PATH`: ESBMC AI requires a path to a JSON config file, the default path is `./config.json`. This can be changed to another path, if there is a preference for multiple files.
-
-### config.json
-
-The following settings are adjustable in the `config.json` file:
-
-1. `ai_model`: The model to use. List of models available [here](https://github.com/Yiannis128/esbmc-ai/wiki/AI-Models).
-2. `ai_custom`: Allows for specifying custom `text-generation-inference` servers to use. For more information see [the wiki page](https://github.com/Yiannis128/esbmc-ai/wiki/AI-Models#custom-llm).
-3. `esbmc_path`: Override the default ESBMC path. Leave blank to use the default ("./esbmc").
-4. `esbmc_params`: Array of strings. This represents the default ESBMC parameters to use when calling ESBMC, these will be used only when no parameters are specified after the filename. **Do not specify a source file to scan in here as ESBMC-AI will inject that in the ESBMC parameters itself**.
-5. `consecutive_prompt_delay`: Rate limit wait time for API calls.
-6. `temp_auto_clean`: Boolean value describing if to clean temporary files from the temporary directory as soon as they are not needed.
-7. `temp_file_dir`: The directory to save temporary files in.
-8. `chat_modes`: Contains settings that belong to each individual chat mode. It is not recommended to change these as changing them will impact the effectiveness of the LLMs.
+See [Configuration Wiki page](https://github.com/Yiannis128/esbmc-ai/wiki/Configuration).
 
 ## Usage
 
-### Basic
-
-ESBMC-AI can be used to scan a file with default parameters like this:
-
-```bash
-./esbmc_ai.py /path/to/source_code.c
-```
-
-### ESBMC-AI Parameters
-
-Any parameters before the filename will be processed and consumed by ESBMC-AI.
-So in this case `-vr` will be consumed by ESBMC-AI, and ESBMC will not get any
-arguments.
-
-```bash
-./esbmc_ai.py -vr /path/to/source_code.c
-```
-
-### Help
-
-```bash
-./esbmc_ai.py -h
-```
-
-### ESBMC Arguments
-
-Below are some very useful arguments that can be passed to ESBMC:
-
-```
-Property checking:
-  --compact-trace                  add trace information to output
-  --no-assertions                  ignore assertions
-  --no-bounds-check                do not do array bounds check
-  --no-div-by-zero-check           do not do division by zero check
-  --no-pointer-check               do not do pointer check
-  --no-align-check                 do not check pointer alignment
-  --no-pointer-relation-check      do not check pointer relations
-  --no-unlimited-scanf-check       do not do overflow check for scanf/fscanf
-                                   with unlimited character width.
-  --nan-check                      check floating-point for NaN
-  --memory-leak-check              enable memory leak check
-  --overflow-check                 enable arithmetic over- and underflow check
-  --ub-shift-check                 enable undefined behaviour check on shift
-                                   operations
-  --struct-fields-check            enable over-sized read checks for struct
-                                   fields
-  --deadlock-check                 enable global and local deadlock check with
-                                   mutex
-  --data-races-check               enable data races check
-  --lock-order-check               enable for lock acquisition ordering check
-  --atomicity-check                enable atomicity check at visible
-                                   assignments
-  --stack-limit bits (=-1)         check if stack limit is respected
-  --error-label label              check if label is unreachable
-  --force-malloc-success           do not check for malloc/new failure
-```
-
-Some examples of passing parameters to ESBMC:
-
-```
-./esbmc_ai.py /path/to/source_code.c --force-malloc-success --no-assertions --unwind 5
-```
-
-Basically, any arguments **after** the filename are passed directly to ESBMC.
-
-### In-Chat Commands Help
-
-Type the following command when inside the chat:
-
-```
-/help
-```
+Read about how to run and use ESBMC-AI in [this wiki page](https://github.com/Yiannis128/esbmc-ai/wiki/Initial-Setup#usage).
 
 ## Contributing
 
@@ -165,10 +65,13 @@ to discuss what you would like to change.
 
 ## Acknowledgments
 
+ESBMC-AI is made possible by the following listed entities:
+
 - [ESBMC](https://github.com/esbmc/esbmc)
 - [OpenAI Chat API](https://platform.openai.com/docs/guides/chat)
 - [Technology Innovation Institute](https://www.tii.ae/)
 - [Hugging Face](https://huggingface.co/)
+ - [Langchain](https://github.com/langchain-ai/langchain)
 
 ## License