From 50792722e9a5308749f8aae6eec6e344b7c9bc23 Mon Sep 17 00:00:00 2001 From: leafspark <78000825+leafspark@users.noreply.github.com> Date: Sat, 24 May 2025 21:27:02 -0700 Subject: [PATCH] docs: update readme for v2.0.1 - added more information about patches and new updates - edited quick start instructions --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1167121..bb9c523 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ # AutoGGUF - automated GGUF model quantizer ![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 repo size](https://img.shields.io/github/repo-size/leafspark/AutoGGUF.svg) -![Lines of Code](https://tokei.rs/b1/github/leafspark/AutoGGUF?category=code) + [![Issues](https://img.shields.io/github/issues/leafspark/AutoGGUF)](https://github.com/leafspark/AutoGGUF/issues) @@ -50,7 +50,7 @@ ## Why AutoGGUF? ## Quick Start -### Cross-platform +### Cross-platform (recommended) 1. `git clone https://github.com/leafspark/AutoGGUF` 2. `cd AutoGGUF` 3. Install dependencies: @@ -73,13 +73,13 @@ ### Windows (for the impatient) 4. Any necessary folders will be automatically created Setup builds: -1. Download setup variant of latest release +1. Download the setup variant of latest release 2. Extract all files to a folder 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 -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 @@ -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). -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 -- Some inconsistent logging and signal handling -- Missing or duplicated translations +- Some inconsistent logging and signal handling +- Missing or duplicated translations (priority) - Buggy/incomplete API interfaces +- Code review and formatting (priority) ## 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) -`Last Updated: 5/15/2025` +`Last Updated: May 24, 2025`