Created Installation (markdown)

leafspark 2024-08-04 16:28:09 -07:00
parent 1f8d597ed1
commit d0edf56356
1 changed files with 56 additions and 0 deletions

56
Installation.md Normal file

@ -0,0 +1,56 @@
## Installation
### Downloading AutoGGUF
To get started with AutoGGUF:
1. Visit the AutoGGUF repository on GitHub
2. Download a prebuilt release or clone the entire repository
### Setting Up the Environment
**Running from source**:
1. Create a new Python virtual environment
2. Install required dependencies:
```
pip install -r requirements.txt
```
3. Run the app: `python src/main.py` or `run.bat`
**Running a prebuilt release:**
1. Extract the zip, and run AutoGGUF.exe by double clicking or the command line (if you'd like to view real time logs)
### Configuration
`AUTOGGUF_LANGUAGE`: sets the language for the app, valid codes below:
* `en-US`: American English
* `fr-FR`: Metropolitan French
* `zh-CN`: Simplified Chinese
* `es-ES`: Spanish (Spain)
* `hi-IN`: Hindi
* `ru-RU`: Russian
* `uk-UA`: Ukrainian
* `ja-JP`: Japanese
* `de-DE`: German
* `pt-BR`: Brazilian Portuguese
* `ar-SA`: Arabic
* `ko-KR`: Korean
* `it-IT`: Italian
* `tr-TR`: Turkish
* `nl-NL`: Dutch
* `fi-FI`: Finnish
* `bn-BD`: Bengali
* `cs-CZ`: Czech
* `pl-PL`: Polish
* `ro-RO`: Romanian
* `el-GR`: Greek
* `pt-PT`: Portuguese (Portugal)
* `hu-HU`: Hungarian
* `en-GB`: British English
* `fr-CA`: Canadian French
* `en-IN`: Indian English
* `en-CA`: Canadian English
* `zh-TW`: Traditional Chinese (Taiwan)
`AUTOGGUF_CHECK_BACKEND`: enabled or disabled, can help if you're having network issues for faster load time.