Skip to content

Commit fb4132a

Browse files
author
Daniil
authored
Merge pull request #22 from Em1tSan/main
Update README.md
2 parents 77fc429 + 727b944 commit fb4132a

File tree

8 files changed

+12
-125
lines changed

8 files changed

+12
-125
lines changed

.github/README.md

Lines changed: 6 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,19 @@
1717
<img src="https://img.shields.io/badge/latest-v1.4.0-indigo.svg" alt="latest"/>
1818
</a>
1919

20+
<br> Советуем сразу посетить <a href="https://github.com/Em1tSan/NeuroGPT/wiki#%D1%80%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9-%D1%8F%D0%B7%D1%8B%D0%BA">wiki проекта</a><br/>
2021
<br> Инструкции по установке: <br/>
2122

22-
<a href="https://github.com/Em1tSan/NeuroGPT#windows">
23+
<a href="https://github.com/Em1tSan/NeuroGPT/wiki/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0-%D0%B8-%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA#windows">
2324
<img src="https://img.shields.io/badge/-Windows-1371c3?logo=windows" alt="windows"/>
2425
</a>
25-
<a href="https://github.com/Em1tSan/NeuroGPT#linux">
26+
<a href="https://github.com/Em1tSan/NeuroGPT/wiki/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0-%D0%B8-%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA#linux">
2627
<img src="https://img.shields.io/badge/-Linux-F1502F?logo=linux" alt="linux"/>
2728
</a>
28-
<a href="https://github.com/Em1tSan/NeuroGPT#macos">
29+
<a href="https://github.com/Em1tSan/NeuroGPT/wiki/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0-%D0%B8-%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA#macos">
2930
<img src="https://img.shields.io/badge/-MacOS-C0BFC0?logo=apple" alt="macos"/>
3031
</a> </p>
31-
<a href="https://github.com/Em1tSan/NeuroGPT#%D0%BF%D0%BE%D1%80%D1%82%D0%B0%D1%82%D0%B8%D0%B2%D0%BD%D0%B0%D1%8F-%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F">
32+
<a href="https://github.com/Em1tSan/NeuroGPT/wiki/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0-%D0%B8-%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA#%D0%BF%D0%BE%D1%80%D1%82%D0%B0%D1%82%D0%B8%D0%B2%D0%BD%D0%B0%D1%8F-%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F">
3233
<img src="https://img.shields.io/badge/-Портативная версия-008000?logo=portable" alt="portable"/>
3334
</a>
3435

@@ -77,62 +78,5 @@
7778
- llama-2-70b-chat
7879
- claude-2
7980
- text-davinci-003
80-
81-
# Установка и запуск
82-
83-
### Портативная версия
84-
85-
Запуск и автообновление в один клик. Не требует установки зависимостей.
86-
Распаковать архив в папку без кириллицы в пути. Нажать `start_portable_webui`
87-
88-
<a href="https://github.com/Em1tSan/NeuroGPT/releases/download/v1.3.0/NeuroGPT-Portable.v1.3.7z">Скачать</a>
89-
90-
---
91-
92-
### [Инструкция по получению API ключей ChimeraAI, PurGPT и Chatty](https://github.com/Em1tSan/NeuroGPT/wiki/%D0%98%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BA%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8E-API-%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%B9-ChimeraAI,-PurGPT-%D0%B8-Chatty)
93-
94-
---
95-
96-
## Windows
97-
Данный проект поддерживает исколючительно версию языка Python не выше 3.10. То есть, с Python 3.11 и выше он **НЕ СОВМЕСТИМ**. Кроме того, работа на Python 3.9, 3.8 не гарантируется.
98-
В данной инструкции рассматриваются только х64-битные версии Windows 10 и 11.
99-
100-
#### 1. Установите Git For Windows
101-
* [Скачайте](https://git-scm.com/download/win) и начните установку git.
10281

103-
![Screenshot](/.github/img/git-01.png)
104-
* Если вы не знаете что отмечать, то оставьте настройки по умолчанию
105-
106-
![Screenshot](/.github/img/git-02.png)
107-
* В окне прописывания в PATH - лучше выбрать среднюю опцию, чтобы команды гита можно было вызывать из любого терминала.
108-
109-
![Screenshot](/.github/img/git-03.png)
110-
#### 2. Установите Visual Studio Community
111-
* [Скачайте](https://visualstudio.microsoft.com/ru/downloads/) и установите Visual Studio Community.
112-
* Ничего сложного, подойдут предлагаемые настройки по умолчанию.
113-
#### 3. Установите Python 3.10.x Windows
114-
* [Скачайте](https://www.python.org/ftp/python/3.10.11/python-3.10.11-amd64.exe) и начните установку Python [3.10.11](https://www.python.org/downloads/release/python-31011/).
115-
116-
![Screenshot](/.github/img/py-01.png)
117-
* Обязательно добавьте в переменные окружения (в PATH).
118-
119-
![Screenshot](/.github/img/py-02.png)
120-
121-
#### 4. Скачайте репозиторий. Для этого откройте командную строку в папке, где хотите разместить NeuroGPT и напишите команду:
122-
`git clone https://github.com/Em1tSan/NeuroGPT.git`
123-
* Откройте папку `NeuroGPT` и запустите файл `start`. Он создаст виртуальную среду, установит зависимости и запустит программу.
124-
* Проверка обновлений происходит автоматически при каждом запуске.
125-
### Запуск Endpoint'а
126-
* Откройте папку `NeuroGPT` и запустите файл `start_endpoint`.
127-
* Проверка обновлений происходит автоматически при каждом запуске.
128-
* Endpoint будет доступен по адресу: `http://127.0.0.1:1337/`
129-
130-
131-
## Linux
132-
133-
## MacOS
134-
135-
## Планы:
136-
* Telegram бот
137-
* Веб-сайт
138-
* Добавление англоязычного интерфейса
82+
***

.github/README_EN.md

Lines changed: 6 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,19 @@ We extend our gratitude to the authors.
1717
<img src="https://img.shields.io/badge/latest-v1.4.0-indigo.svg" alt="latest"/>
1818
</a>
1919

20+
<br> We recommend visiting <a href="https://github.com/Em1tSan/NeuroGPT/wiki#english-language">our project's wiki</a> right away.<br/>
2021
<br> Installation instructions: <br/>
2122

22-
<a href="https://github.com/Em1tSan/NeuroGPT#windows">
23+
<a href="https://github.com/Em1tSan/NeuroGPT/wiki/Installing-and-running#windows">
2324
<img src="https://img.shields.io/badge/-Windows-1371c3?logo=windows" alt="windows"/>
2425
</a>
25-
<a href="https://github.com/Em1tSan/NeuroGPT#linux">
26+
<a href="https://github.com/Em1tSan/NeuroGPT/wiki/Installing-and-running#linux">
2627
<img src="https://img.shields.io/badge/-Linux-F1502F?logo=linux" alt="linux"/>
2728
</a>
28-
<a href="https://github.com/Em1tSan/NeuroGPT#macos">
29+
<a href="https://github.com/Em1tSan/NeuroGPT/wiki/Installing-and-running#macos">
2930
<img src="https://img.shields.io/badge/-MacOS-C0BFC0?logo=apple" alt="macos"/>
3031
</a> </p>
31-
<a href="https://github.com/Em1tSan/NeuroGPT#%D0%BF%D0%BE%D1%80%D1%82%D0%B0%D1%82%D0%B8%D0%B2%D0%BD%D0%B0%D1%8F-%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F">
32+
<a href="https://github.com/Em1tSan/NeuroGPT/wiki/Installing-and-running#portable-version">
3233
<img src="https://img.shields.io/badge/-Portable version-008000?logo=portable" alt="portable"/>
3334
</a>
3435

@@ -78,62 +79,4 @@ Given that this project doesn't use an official API but relies on reverse-engine
7879
- claude-2
7980
- text-davinci-003
8081

81-
# Installing and Running
82-
83-
### Portable version
84-
85-
One-click program launch and auto-update. No dependencies installation required.
86-
Unpack the archive into a folder whose path does not contain Cyrillic. Press `start_portable_webui`.
87-
88-
89-
<a href="https://github.com/Em1tSan/NeuroGPT/releases/download/v1.3.0/NeuroGPT-Portable.v1.3.7z">Скачать</a>
90-
91-
---
92-
93-
### [Instructions for obtaining API keys for ChimeraAI, PurGPT, and Chatty](https://github.com/Em1tSan/NeuroGPT/wiki/%D0%98%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BA%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8E-API-%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%B9-ChimeraAI,-PurGPT-%D0%B8-Chatty)
94-
95-
---
96-
97-
## Windows
98-
This project only supports Python language version up to 3.10. That is, it is **NOT COMPATIBLE** with Python 3.11 and above. Moreover, its operation is not guaranteed on Python 3.9 and 3.8.
99-
This guide only considers x64-bit versions of Windows 10 and 11.
100-
101-
#### 1. Install Git For Windows
102-
* [Download](https://git-scm.com/download/win) and start installing git.
103-
104-
![Screenshot](/.github/img/git-01.png)
105-
* If unsure, choose default settings.
106-
107-
![Screenshot](/.github/img/git-02.png)
108-
* In the PATH entry window, choose the middle option to call git commands from any terminal.
109-
110-
![Screenshot](/.github/img/git-03.png)
111-
#### 2. Install Visual Studio Community
112-
* [Download](https://visualstudio.microsoft.com/ru/downloads/) and install Visual Studio Community.
113-
* Nothing complicated; default settings offered will suffice.
114-
#### 3. Install Python 3.10.x Windows
115-
* [Download](https://www.python.org/ftp/python/3.10.11/python-3.10.11-amd64.exe) and start the Python installation. [3.10.11](https://www.python.org/downloads/release/python-31011/).
116-
117-
![Screenshot](/.github/img/py-01.png)
118-
* Be sure to add it to the environment variables (in PATH).
119-
120-
![Screenshot](/.github/img/py-02.png)
121-
122-
#### 4. Download the repository by opening the command line in the folder where you want to place NeuroGPT and typing the following command:
123-
`git clone https://github.com/Em1tSan/NeuroGPT.git`
124-
* Open `NeuroGPT` folder and run `start` file. It will create a virtual environment, install dependencies, and launch the program.
125-
* The program automatically checks for updates with each launch.
126-
### Running API endpoint
127-
* Open `NeuroGPT` folder and run `start_endpoint` file.
128-
* The program automatically checks for updates with each launch.
129-
* API endpoint will be available at: `http://127.0.0.1:1337/`
130-
131-
132-
## Linux
133-
134-
## MacOS
135-
136-
## Планы:
137-
* Telegram bot
138-
* Website
139-
* English language interface
82+
***

.github/img/docker-desktop.png

-81.3 KB
Binary file not shown.

.github/img/git-01.png

-19.4 KB
Binary file not shown.

.github/img/git-02.png

-19.9 KB
Binary file not shown.

.github/img/git-03.png

-24.5 KB
Binary file not shown.

.github/img/py-01.png

-77.9 KB
Binary file not shown.

.github/img/py-02.png

-78.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)