Readme and version update

Readme and version update

Readme and version update

Readme and version update

Author: tomteipl

App/Linux/OllamaGUIChat.py

@@ -33,7 +33,7 @@ def set_settings():
                     settings.write(cf)
 
             try:
-                ctk.set_appearance_mode(appearance)
+                ctk.set_appearance_mode(str(appearance))
 
             except Exception as e:
                 print(f"Error while reading appearance mode: {e}")
@@ -304,7 +304,7 @@ def setup_ui(self):
         self.send_button.grid(row=3, column=1, sticky="we", padx=(0,5), pady=(5,5))
         self.send_button.configure(height=100, width=10, corner_radius=5, border_width=2)
 
-        self.copyright_label = ctk.CTkLabel(self, text="Copyright © 2025 by Kamil Wiśniewski | Ver. 1.7.0")
+        self.copyright_label = ctk.CTkLabel(self, text="Copyright © 2025 by Kamil Wiśniewski | Ver. 2.0.0")
         self.copyright_label.grid(sticky="se", row=4, column=0, columnspan=2, padx=5)
         self.copyright_label.configure(font=("", 10))
 

README.md

@@ -2,7 +2,7 @@
     <h1> Ollama-GUI-Chat </h1>
 </div>
 
-![OGC default colors photo](assets/Ollama_default_colors5.png)
+![OGC default colors photo](assets/themes_1.png)
 
 ![GitHub License](https://img.shields.io/github/license/tomteipl/Ollama-GUI-Chat?style=for-the-badge&logo=apache&logoSize=auto&labelColor=%235c549f&color=orange)
 ![GitHub commit activity](https://img.shields.io/github/commit-activity/t/tomteipl/Ollama-GUI-Chat?style=for-the-badge&logo=githubactions&logoColor=black&logoSize=auto&labelColor=%235c549f&color=orange)
@@ -26,29 +26,32 @@ there is inserted default URL.
 
 * **[Features][1]**
 * **[Installation][2]**
-* **[Customization][3]**
-* **[Themes][4]**
-  * [Gruvbox][5]
-  * [Tokyo Night][6]
-* **[Roadmap][7]**
+* **[Usage][3]**
+* **[Customization][4]**
+* **[Themes][5]**
+  * [Gruvbox][6]
+  * [Tokyo Night][7]
+* **[Roadmap][8]**
 * **[License](LICENSE)**
 
 [1]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#features
 [2]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#installation
-[3]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#customization
-[4]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#themes
-[5]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#gruvbox
-[6]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#tokyo-night
-[7]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#roadmap
+[3]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#usage
+[4]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#customization
+[5]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#themes
+[6]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#gruvbox
+[7]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#tokyo-night
+[8]: https://github.com/tomteipl/Ollama-GUI-Chat?tab=readme-ov-file#roadmap
 
 ## 🔥 Features
 
-* ✏️ Talk with **Ollama** AI models with style using light GUI app.
-* 📂 Choose a model from the list or type your **own** model name.
-* 🔖 Save and Clear chat history.
-* 🍻 Load chat from a saved file and continue your conversation.
+* ✏️ Talk with **LLM** AI models with style using light GUI app.
+* 📂 Auto detect your models from **Host URL**.
+* 🌟 `settings.ini`, saves selected theme, URl and light/dark mode.
+* 🔖 Save, load and Clear chat.
+* 🍻 Switch themes with a simple button.
 * 🌓 Light and Dark modes.
-* 🗽 Auto detect your LLMs.
+* 🗽 Toggle `autoscroll`.
 * 🌹 **Most important**, customize the style of the whole app with a simple `JSON` file !
 * 🎁 Its free and open-source. Use the source code to customize the app even more !
 * And **more** in development...
@@ -59,21 +62,93 @@ there is inserted default URL.
 > You are required to have installed **[Ollama](https://ollama.com/)**.
 > Please refer to the official website for installation instructions.
 
+**TL;DR**:
+
 * **Download** the latest [release](https://github.com/tomteipl/Ollama-GUI-Chat/releases/latest).
 * **Extract** the archive.
 * **Enjoy!**
 
->[!NOTE]
->*`custom_theme.json` is located inside of `_internal/theme` folder.*
+## Usage
+
+>[!IMPORTANT]
+> On the first message, the app may take a while to respond due to setting up a server.
+
+When you launch the app *for the first time*, it will create
+`settings.ini` (also after you manually remove it).
+By default it will look like this:
+
+```ini
+[Settings]
+theme = default.json
+host = http://localhost:11434
+appearance = light
+```
+
+* `[theme]` = `...`, this value will change depending on the
+theme picked from the *Change theme* button.
+
+![theme button](assets/change_theme_1.png)
+
+Or:
+
+You can add your own theme files and
+type its `json` file name. Theme has to be placed in
+`_internal/theme/` folder.
+
+* `[host]` = `...`, this value is used for fetching your LLM models.
+It is automatically inserted into the `host_url` entry field.
+You can change it in the `settings.ini` file or by typing a
+new URL into the entry field and hitting the **"Enter"** key.
+This will fetch new models and save them to settings.
+
+* `[appearance]` = `light` or `dark`, which simply saves the dark mode preference,
+so you don't have to change it each time you open the app.
+
+### Saving and loading
+
+If you wish, you can save whole conversation by
+pressing a `Save` button. It will open a save window,
+select any location, name and save it as `.txt` file.
+
+Loading a chat is no harder. Press `Load` button
+and select `.txt` file that you created earlier.
+You will not get any prompt. I usually type
+`What was my first message?` and it responds according to
+the file that i loaded.
+
+>[!TIP]
+>The AI doesn't recognize from what LLM the chat was,
+>so you can load for example a conversation from
+>`llama3.1` into `gemma3`.
+
+### Other features
+
+* **Autoscroll** checkbox - whenever you want to hold the page
+and read, uncheck the box. If you check it again it will
+move you to the last generating line.
+
+* **Font size** - You can increase/decrease the chat font by
+pressing **red arrows**. This value is not being saved
+in `settings.ini`.
+
+* **Clear chat** - like the name says it clears the chat window
+and **Clears the conversation history** so the AI will
+not remember this conversation.
+
+* **Stop button**: Whenever the AI is generating a response,
+the **stop** button will pop up alongside the **progress bar**.
+When you hit it, of course it will stop the conversation,
+but also it will remove your last question from the history.
 
 ## 💻 Customization
 
-![OGC default colors photo](assets/Ollama_default_colors7.png)
+![OGC default colors photo](assets/Ollama_default_colors_both.png)
 
-You can customize the style of the app by editing `custom-theme.json`.
+You can customize the style of the app by editing `*.json`.
+Or by adding your own theme files.
 **OGC** searches for the `json` file in the `_internal/theme/` folder.
 
-Part of the `custom-theme.json` file:
+Part of the `default.json` file:
 
 ```json
 {
@@ -102,32 +177,28 @@ Its pretty easy and self-explanatory. Just change the values
 and see the changes in the app.
 You can use `HEX` colors or `names` like `"green"`.
 
+Some of the values are **hard coded** and `json` file
+has no impact on them.
+
 Detailed usage of theme file can be found on
 the official [CustomTkinter](https://customtkinter.tomschimansky.com/documentation/)
 page.
 
-If you wish you can modify `PATHs` to app and theme
-
-```python
-APP_PATH: str = os.path.dirname(os.path.realpath(__file__))
-THEME_PATH: str = os.path.join(APP_PATH, "theme", "custom-theme.json")
-```
-
 ## 🎨 Themes (WIP)
 
 You can find more themes in **[themes](themes/)** folder.
 Each theme has light and dark mode.
 
->[!TIP]
->Copy and paste whole code from any theme preset into `custom_theme.json`.
+>[!NOTE]
+>Default themes are included in the release file.
 
 ### Gruvbox
 
-![Gruvbox Theme](assets/Ollama_gruvbox_2.png)
+![Gruvbox Theme](assets/Ollama_gruvbox_both.png)
 
 ### Tokyo Night
 
-![Tokyo Night Theme](assets/Ollama-tokyo_night_2.png)
+![Tokyo Night Theme](assets/Ollama_tokyo_night_both.png)
 
 ## 📆 Roadmap
 
@@ -144,7 +215,7 @@ Start: **27.03.2025**
 * [x] ~**Improve UI**~
 * [x] ~**Change theme handling**~
 
-Finished: **01.04.2025**
+Finished: 💥**01.04.2025**💥
 
 ## License