[docs] Updated README

happycod3r · Jul 28, 2023 · bfb182e · bfb182e
1 parent 32cb016
commit bfb182e
Showing 1 changed file with 65 additions and 55 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,10 +1,10 @@
 # WinGPT v1.0.0
 
-![](/docs/res/wingtp1.png)
+![WinGTP Logo](/docs/res/wingtp1.png)
 
 > WinGTP is a cross-platform, fully functional, full-featured GUI implementation of the OpenAI API.
-> You need a free OpenAI API key to use WinGTP. If you don't already have 
-> one you can find one at [https://openai.com/](https://openai.com/) 
+> You need a free OpenAI API key to use WinGTP. If you don't already have
+> one you can find one at [https://openai.com/](https://openai.com/)
 
 - [WinGPT v1.0.0](#wingpt-v100)
   - [About](#about)
@@ -22,10 +22,6 @@
       - [Using Curl:](#using-curl)
   - [Usage](#usage)
     - [OpenAI API Key](#openai-api-key)
-  - [](#)
-  - [](#-1)
-  - [](#-2)
-  - [](#-3)
     - [Running WinGTP](#running-wingtp)
       - [python](#python)
   - [Contributing](#contributing)
@@ -37,36 +33,39 @@
 
 ## [About](#about)
 
-### [Cross-platform](#cross-platform): 
+This is just version 1 of many updates to come still, so the gui will improve vastly in the very near future. I really wanted to focus on functionality and wrapping
+the gui around the openai api in a way that will give you full control. It should be a 1|1 wrapper around the api and I think WinGTP accomplishes that.
+
+### [Cross-platform](#cross-platform)
+
 Because WinGTP is built purely in Python, it will work on Windows, Mac and Linux operating systems.
 
-### [Full-featured](#full-featured):
+### [Full-featured](#full-featured)
 
-* Chat, files, audio transcription, image edits, image variations, new images, translations, embeddings, fine-tuning, moderations, sentement analysis, q&a, summarization and code generation are all available and easy to use. 
+- hat, files, audio transcription, image edits, image variations, new images, translations, embeddings, fine-tuning, moderations, sentement analysis, q&a, summarization and code generation are all available and easy to use.
 
 ### [Control all api settings](#control-all-api-settings)
-* Switch between all available models using a simple drop down menu.
-* Easily control all available parameters such as: temperature, max tokens, response count, best of, frequency & presence penalty, timeout, user etc. from a modern gui to easily adjust responses.
-* Use user defined data files, and jsonl data files. 
-* View and change other settings like api_type, api_base and api_version.  
-* Stream, echo, or save chat at any time.
-* Create chat stop lists. 
+
+- Switch between all available models using a simple drop down menu.
+- Easily control all available parameters such as: temperature, max tokens, response count, best of, frequency & presence penalty, timeout, user etc. from a modern gui to easily adjust responses.
+- Use user defined data files, and jsonl data files.
+- View and change other settings like api_type, api_base and api_version.  
+- Stream, echo, or save chat at any time.
+- Create chat stop lists.
 
 ### [Persistent Settings](#persistent-settings)
-* Your api key is stored so you only need to enter it once during setup and it will be automatically loaded on next startup. 
-* If you have multiple api keys, you can easily switch between them. 
 
-* Organization settings are also available to control which organization is used by default when making requests with your API keys       
+- Your api key is stored so you only need to enter it once during setup and it will be automatically loaded on next startup.
+- If you have multiple api keys, you can easily switch between them.
+- Organization settings are also available to control which organization is used by default when making requests with your API keys.
 
 ### [Personalization Settings](#personalization-settings)
-* Light, Dark & System themes are currently available. 
-* Easily change the color of the output and accent of the gui controls.
-* UI scaling options are also available 
 
-* This is just version 1 of many updates to come still so the gui will improve vastly in the very near future. I'm a one man show and really wanted to focus on functionality and wrapping 
-the gui around the openai. I wanted to create a 1|1 wrapper around the api and I think WinGTP accomplishes that.
+- Light, Dark & System themes are currently available.
+- Easily change the color of the output and accent of the gui controls.
+- UI scaling options are also available.
 
-![](./res/wingtp-hello-example.gif)
+![Hello World](./res/wingtp-hello-example.gif)
 
 ## [Notes](#notes)
 
@@ -85,22 +84,23 @@ to the OpenAI api a connection is required.
 3) Lastly you need an api key to finish the WinGTP setup. Check out the [API Key](#openai-api-key) section.
 
 ## [Install](#install)
+
 Currently there is no installer yet as WinGTP is still being actively developed. You can use it simply by running the `init.py` file with **Python 3.11** or higher or by using the included `wingtp-v0.1.0.bat` file which will run it for you.
 
 Soon an executable will be available! once I feel version 1 is polished enough I'll bundle everything and release an executable for you to use, as running things from the command line isn't ideal for everyone.
 
 To download and use WinGTP choose an install method and follow the corresponding steps. Once fininshed jump to the [Usage](#usage) section.
 
-> You need a free OpenAI API key to finish the setup. If you don't already have 
-> one you can find one at [https://openai.com/](https://openai.com/) 
+> You need a free OpenAI API key to finish the setup. If you don't already have
+> one you can find one at [https://openai.com/](https://openai.com/)
 
-### [Manual Install](#manual_install) 
+### [Manual Install](#manual-install)
 
 1. Simply download and place the ***WinGTP*** folder in a location of your choosing then follow one of the methods in the [Usage](#usage) section to get started.
 
-### [Command Line Install](#command_line_install)
+### [Command Line Install](#command-line-install)
 
-#### [Using Git Clone:](#git_clone)
+#### [Using Git Clone:](#using-git-clone)
 
 1) Open your terminal and navigate to the directory where you want to clone the repository: 
 
@@ -109,65 +109,72 @@ cd where/I/want/to/install
 ```
 
 2) Next run the following command to clone the repository to the chosen location:
+
 ```bash
 git clone https://github.com/happycod3r/WinGTP.git
 ```
 
-#### [Using Curl:](#curl)
+#### [Using Curl:](#using-curl)
 
 1) Pick a directory to download it to:
+
 ```bash
 cd where/I/want/to/install
 ```
 
 2) Paste the following line into your terminal and press the `Enter` key:
+
 ```bash
 curl https://github.com/happycod3r/WinGTP.git
 ```
 
-Once you have the repository cloned or downloaded your good to go. All you need 
-now is Python and an api key from 
+Once you have the repository cloned or downloaded your good to go. All you need
+now is Python and an api key from [https://openai.com](https://openai.com)
 
 ## [Usage](#usage)
 
 ### [OpenAI API Key](#openai-api-key)
 
-> None of your personal information is required to use WinGTP except your [API key]() 
-> which is stored locally on your machine. Your api key is never shared or entered into 
-> any kind of database. Everything is local. OpenAI may collect data but you'll have to 
-> check out the OpenAI website as I am not affiliated, sponsered, or contracted with 
-> OpenAI in any way, shape or form.
+> None of your personal information is required to use WinGTP except your [API Key](#openai-api-key)
+> which is stored locally on your machine. Your api key is never shared or entered into
+> any kind of database. Everything is local. OpenAI may collect data but you'll have to
+> check out the OpenAI website as I am not affiliated, sponsered, or contracted with
+> OpenAI in any way, shape or form. I'm just a dude in a place.
 
 **!!!Any API keys used in these examples were deleted immediately after!!!**
 
-This step is really important to setup in order to use WinGTP. Since the application 
-is wrapped around the Python `openai` module heavily you need an OpenAI api key to use it. 
+This step is really important to setup in order to use WinGTP. Since the application
+is wrapped around the Python `openai` module heavily you need an OpenAI api key to use it.
 You can easily obtain a free api key by following the next few steps.
 
-1) Go to [https://openai.com/](https://openai.com/) and either create a free account 
+1) Go to [https://openai.com/](https://openai.com/) and either create a free account
 manually or continue using **Google** or any other option for the quickest setup.
 
 ![setup1](./res/setup1.gif)
+
 ---
 
 2) Once you have an account created click on your profile picture and then **"View API Keys"**.
 
 ![setup2](./res/setup2.gif)
+
 ---
 
 3) Next you will be met with a page like this where you can access or create new api keys.
 Create a new key to use if you don't already have one.
 
 ![setup3](./res/setup3.gif)
+
 ---
 
 4) Once you have an api key you can use it to setup WinGTP. Enter your username and
-then the api key below it. 
+then the api key below it.
 
 ![setup4](./res/setup4.gif)
+
 ---
 
-### [Running WinGTP](#running)
+### [Running WinGTP](#running-wingtp)
 
 1) To start WinGTP on Windows you can double-click the `wingtp-0.1.0.bat` file.
 
@@ -178,37 +185,40 @@ simply runs the `init.py` file using the `python` command which starts WinGTP.
 ```bash
 # wingtp-0.1.0.bat
 python "./init.py"
-``` 
+```
+
+2) Next you will see a setup screen where you should enter a username that you would
+like to use within WinGTP and your OpenAI api key.
 
-2) Next you will see a setup screen where you should enter a username that you would 
-like to use within WinGTP and your OpenAI api key. 
-> Without an api key you will not be able to access WinGTP as none of it's features 
-> will work without it. If you need further instructions on how to obtain one check 
+> Without an api key you will not be able to access WinGTP as none of it's features
+> will work without it. If you need further instructions on how to obtain one check
 > out the [OpenAI API Key](#openai-api-key) section.
 
 #### [python](#python)
 
 1) WinGTP was built using Python 3.11 so make sure you are using the same or newer.
 2) In your terminal navigate to the WinGTP root directory.
+
 ```bash
 cd WinGTP
 ```
+
 3) Finally, run the following command to start WinGTP:
 
 ```bash
 python init.py
 ```
+
 ---
 
-Once the setup winow closes you will then be greeted by GTP with a greeting including your 
+Once the setup winow closes you will then be greeted by GTP with a greeting including your
 username.
 
 The following are examples of some of the main features mentioned in the [About](#about) section.
 
-
 ## [Contributing](#contributing)
 
-If you have any feature requests, suggestions or general questions you can reach me via any of the 
+If you have any feature requests, suggestions or general questions you can reach me via any of the
 methods listed below in the [Contacts](#contacts) section.
 
 ---
@@ -225,9 +235,9 @@ methods listed below in the [Contacts](#contacts) section.
 
 **Author:** Paul M.
 
-* Email: [[email protected]](mailto:[email protected])
-* Github: [https://github.com/happycod3r](https://github.com/happycod3r)
-* Linkedin: [https://www.linkedin.com/in/paul-mccarthy-89165a269/]( https://www.linkedin.com/in/paul-mccarthy-89165a269/)
-* Facebook: [https://www.facebook.com/paulebeatz]( https://www.facebook.com/paulebeatz)
+- Email: [[email protected]](mailto:[email protected])
+- Github: [https://github.com/happycod3r](https://github.com/happycod3r)
+- Linkedin: [https://www.linkedin.com/in/paul-mccarthy-89165a269/]( https://www.linkedin.com/in/paul-mccarthy-89165a269/)
+- Facebook: [https://www.facebook.com/paulebeatz]( https://www.facebook.com/paulebeatz)
 
 ---