upgraded README.md

This commit is contained in:
ParisNeo 2023-04-06 23:29:20 +02:00
parent 258c43c5dd
commit ebe39b0b74

View File

@ -57,15 +57,28 @@ These scripts will create a Python virtual environment and install the required
Now you're ready to work! Now you're ready to work!
## Usage ## Usage
For simple newbies on Windows: For simple newbies on Windows:
```bash ```cmd
run.bat run.bat
``` ```
For simple newbies on Linux/MacOsX: For simple newbies on Linux/MacOsX:
```bash ```bash
run.bat run.sh
``` ```
if you want more control on your launch, you can activate your environment:
On Windows:
```cmd
env/Scripts/activate.bat
```
On Linux/MacOs:
```cmd
source venv/bin/activate
```
Now you are ready to customize your Bot.
To run the Flask server, execute the following command: To run the Flask server, execute the following command:
```bash ```bash
@ -137,14 +150,3 @@ We are excited about these future plans for the project and look forward to impl
## License ## License
This project is licensed under the Apache 2.0 License. See the [LICENSE](https://github.com/nomic-ai/GPT4All-ui/blob/main/LICENSE) file for details. This project is licensed under the Apache 2.0 License. See the [LICENSE](https://github.com/nomic-ai/GPT4All-ui/blob/main/LICENSE) file for details.
## Special thanks
Special thanks to :
- [cclaar-byte](https://github.com/cclaar-byte)
- [CybearWarfare](https://github.com/CybearWarfare)
- [Jan Brummelte](https://github.com/brummelte)
- [higorvaz](https://github.com/higorvaz)
for their contributions.