Add doc

zhuzilin · Dec 9, 2022 · 3a1fc76 · 3a1fc76
1 parent 6299029
commit 3a1fc76
Show file tree

Hide file tree

Showing 6 changed files with 1,624 additions and 1,690 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,41 @@
-OpenAI ChatGPT Desktop built with Electron
+# OpenAI ChatGPT Desktop built with Electron
+
+<img src="img/header.png" style="zoom: 33%;" />
+
+## Install
+
+Download the dmg file from the latest release.
+
+## Manually load cookie
+
+<img src="img/set-cookie.png" style="zoom:33%;" />
+
+If you are not able to normally login, you could use \[Tool\] -> [Set Cookie] to load session token into cookie from a certain file.
+
+To get the sesson token, check the instruction in [chatgpt-api](https://github.com/transitive-bullshit/chatgpt-api#session-tokens). 
+
+## Run from source
+
+Clone the code from github and download the dependencies:
+
+```bash
+git clone [email protected]:zhuzilin/chatgpt-desktop.git
+cd chatgpt-desktop/
+npm install
+```
+
+Run with npm:
+
+```bash
+npm start
+```
+
+Build the installer:
+
+```bash
+npm run build
+```
+
+## Help needed!
+
+It would be great if someone could help me with the windows and linux build :)
diff --git a/img/header.png b/img/header.png
diff --git a/img/set-cookie.png b/img/set-cookie.png