leafspark
/
AutoGGUF
mirror of https://github.com/leafspark/AutoGGUF
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update readme for v2.0.1 

- added more information about patches and new updates
- edited quick start instructions
This commit is contained in:
leafspark 2025-05-24 21:27:02 -07:00 committed by GitHub
parent 7c2a0b7ec1
commit 50792722e9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -18,7 +18,7 @@ # AutoGGUF - automated GGUF model quantizer
![GitHub forks](https://img.shields.io/github/forks/leafspark/AutoGGUF.svg) ![GitHub forks](https://img.shields.io/github/forks/leafspark/AutoGGUF.svg)
![GitHub release (latest by date)](https://img.shields.io/github/downloads/leafspark/AutoGGUF/latest/total?color=green) ![GitHub release (latest by date)](https://img.shields.io/github/downloads/leafspark/AutoGGUF/latest/total?color=green)
![GitHub repo size](https://img.shields.io/github/repo-size/leafspark/AutoGGUF.svg) ![GitHub repo size](https://img.shields.io/github/repo-size/leafspark/AutoGGUF.svg)
![Lines of Code](https://tokei.rs/b1/github/leafspark/AutoGGUF?category=code) <!-- ![Lines of Code](https://ghloc.vercel.app/leafspark/AutoGGUF?filter=.bat$,.py$,.sh$,.bat$) -->
<!-- Contribution --> <!-- Contribution -->
[![Issues](https://img.shields.io/github/issues/leafspark/AutoGGUF)](https://github.com/leafspark/AutoGGUF/issues) [![Issues](https://img.shields.io/github/issues/leafspark/AutoGGUF)](https://github.com/leafspark/AutoGGUF/issues)
@ -50,7 +50,7 @@ ## Why AutoGGUF?
## Quick Start ## Quick Start
### Cross-platform ### Cross-platform (recommended)
1. `git clone https://github.com/leafspark/AutoGGUF` 1. `git clone https://github.com/leafspark/AutoGGUF`
2. `cd AutoGGUF` 2. `cd AutoGGUF`
3. Install dependencies: 3. Install dependencies:
@ -73,13 +73,13 @@ ### Windows (for the impatient)
4. Any necessary folders will be automatically created 4. Any necessary folders will be automatically created
Setup builds: Setup builds:
1. Download setup variant of latest release 1. Download the setup variant of latest release
2. Extract all files to a folder 2. Extract all files to a folder
3. Run the setup program 3. Run the setup program
4. The .GGUF extension will be registered with the program automatically 4. The .gguf extension will be registered with the program automatically
5. Run the program from the Start Menu or desktop shortcuts 5. Run the program from the Start Menu or desktop shortcuts
After launching the program, you may access its local server at port 7001 (set `AUTOGGUF_SERVER` to "enabled" first) After launching the program, you may access its local server at port 7001 (set `AUTOGGUF_SERVER` to "enabled" first).
### Verifying Releases ### Verifying Releases
@ -132,15 +132,16 @@ ## Localizations
View the list of supported languages at [AutoGGUF/wiki/Installation#configuration](https://github.com/leafspark/AutoGGUF/wiki/Installation#configuration) (LLM translated, except for English). View the list of supported languages at [AutoGGUF/wiki/Installation#configuration](https://github.com/leafspark/AutoGGUF/wiki/Installation#configuration) (LLM translated, except for English).
More languages will be updated as soon as possible! Languages will be updated as soon as possible after an update, or as a part of the update.
To use a specific language, set the `AUTOGGUF_LANGUAGE` environment variable to one of the listed language codes (note: some languages may not be fully supported yet, those will fall back to English). To use a specific language, set the `AUTOGGUF_LANGUAGE` environment variable to one of the listed language codes (note: some languages may not be fully supported yet, in which the UI elements will fall back to English).
## Issues ## Issues
- Some inconsistent logging and signal handling - Some inconsistent logging and signal handling
- Missing or duplicated translations - Missing or duplicated translations (priority)
- Buggy/incomplete API interfaces - Buggy/incomplete API interfaces
- Code review and formatting (priority)
## Planned Features ## Planned Features
@ -166,4 +167,4 @@ ## Stargazers
[![Star History Chart](https://api.star-history.com/svg?repos=leafspark/AutoGGUF&type=Date)](https://star-history.com/#leafspark/AutoGGUF&Date) [![Star History Chart](https://api.star-history.com/svg?repos=leafspark/AutoGGUF&type=Date)](https://star-history.com/#leafspark/AutoGGUF&Date)
`Last Updated: 5/15/2025` `Last Updated: May 24, 2025`