diff --git a/README.md b/README.md
index 1884a7692..231e756df 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,53 @@
-# 🧑✈️ GPT PILOT
+
+
+# 🧑✈️ GPT PILOT 🧑✈️
+
+
+
+---
+
+
+
+[](https://discord.gg/HaqXugmxr9)
+[](https://github.com/Pythagora-io/gpt-pilot)
+[](https://twitter.com/HiPythagora)
+
+
+
+---
+
+
+
+
+
+
+
+
+
+### GPT Pilot doesn't just generate code, it builds apps!
+
+
+
+---
+
+
+[](https://youtu.be/4g-1cPGK0GA)
-
-### GPT Pilot is a true AI developer that writes code, debugs it, talks to you when it needs help, etc.
+(click to open the video in YouTube) (1:40min)
-You specify what kind of app you want to build. Then, GPT Pilot asks clarifying questions, creates the product and technical requirements, sets up the environment, and **starts coding the app step by step, like in real life, while you oversee the development process**. It asks you to review each task it finishes or to help when it gets stuck. This way, GPT Pilot acts as a coder while you are a lead dev who reviews code and helps when needed.
+
+
-GPT Pilot is the core technology for the [VS Code extension](https://bit.ly/3IeZxp6) that aims to provide **the first real AI developer companion**. Not just an autocomplete or a helper for PR messages but rather a real AI developer that can write full features, debug them, talk to you about issues, ask for review, etc.
+
-### **[👉 Examples of apps written by GPT Pilot 👈](#-examples)**
+### **[👉 Examples of apps written by GPT Pilot 👈](https://github.com/Pythagora-io/gpt-pilot/wiki/Apps-created-with-GPT-Pilot)**
-
-https://github.com/Pythagora-io/gpt-pilot/assets/10895136/0495631b-511e-451b-93d5-8a42acf22d3d
+---
# 🔌 Requirements
- **Python 3.9+**
-- **PostgreSQL** (Optional, default database is SQLite)
- - DB is needed for multiple reasons like continuing app development. If you have to stop at any point or the app crashes, go back to a specific step so that you can change some later steps in development, and easier debugging, in future we will add functionality to update project (change some things in existing project or add new features to the project and so on).
-
# 🚦How to start using gpt-pilot?
👉 If you are using VS Code as your IDE, the easiest way to start is by downloading [GPT Pilot VS Code extension](https://bit.ly/3IeZxp6). 👈
@@ -80,13 +111,15 @@ After you have Python and (optionally) PostgreSQL installed, follow these steps:
- Your API key
- database settings: SQLite/PostgreSQL (to change from SQLite to PostgreSQL, just set `DATABASE_TYPE=postgres`)
- optionally set IGNORE_PATHS for the folders which shouldn't be tracked by GPT Pilot in workspace, useful to ignore folders created by compilers (i.e. `IGNORE_PATHS=folder1,folder2,folder3`)
-9. `python db_init.py` (initialize the database)
-10. `python main.py` (start GPT Pilot)
+9. `python main.py` (start GPT Pilot)
After, this, you can just follow the instructions in the terminal.
All generated code will be stored in the folder `workspace` inside the folder named after the app name you enter upon starting the pilot.
+# 🔎 [Examples](https://github.com/Pythagora-io/gpt-pilot/wiki/Apps-created-with-GPT-Pilot)
+
+[Click here](https://github.com/Pythagora-io/gpt-pilot/wiki/Apps-created-with-GPT-Pilot) to see all example apps created with GPT Pilot.
## 🐳 How to start gpt-pilot in docker?
1. `git clone https://github.com/Pythagora-io/gpt-pilot.git` (clone the repo)
@@ -95,8 +128,7 @@ All generated code will be stored in the folder `workspace` inside the folder na
4. run `docker compose build`. this will build a gpt-pilot container for you.
5. run `docker compose up`.
6. access the web terminal on `port 7681`
-7. `python db_init.py` (initialize the database)
-8. `python main.py` (start GPT Pilot)
+7. `python main.py` (start GPT Pilot)
This will start two containers, one being a new image built by the `Dockerfile` and a Postgres database. The new image also has [ttyd](https://github.com/tsl0922/ttyd) installed so that you can easily interact with gpt-pilot. Node is also installed on the image and port 3000 is exposed.
@@ -111,20 +143,15 @@ Lists all existing apps.
python main.py --get-created-apps-with-steps
```
-## `app_id` and `workspace`
+
+
+## `app_id`
Continue working on an existing app using **`app_id`**
```bash
python main.py app_id=
```
-_or_ **`workspace`** path:
-
-```bash
-python main.py workspace=
-```
-
-Each user can have their own workspace path for each App.
-
+
## `step`
Continue working on an existing app from a specific **`step`** (eg: `development_planning`)
@@ -132,77 +159,37 @@ Continue working on an existing app from a specific **`step`** (eg: `development
python main.py app_id= step=
```
+
## `skip_until_dev_step`
Continue working on an existing app from a specific **development step**
```bash
python main.py app_id= skip_until_dev_step=
```
-This is basically the same as `step` but during the development process. If you want to play around with gpt-pilot, this is likely the flag you will often use.
+Continue working on an existing app from a specific **`development step`**. If you want to play around with GPT Pilot, this is likely the flag you will often use.
+
-Erase all development steps previously done and continue working on an existing app from the start of development.
```bash
python main.py app_id= skip_until_dev_step=0
```
+Erase all development steps previously done and continue working on an existing app from the start of development.
+
## `theme`
```bash
python main.py theme=light
```
-
-
```bash
python main.py theme=dark
```
-- Dark mode.
-
-
-# 🔎 Examples
-### Backend system for billing, admin, and user management
-- 💬 [Full initial prompt + additional features prompts](https://github.com/Pythagora-io/credit-based-backend-gpt-pilot-example/tree/main/prompts)
-- ▶️ [Video overview of app features](https://youtu.be/-OB6BJKADEo)
-- 💻️ [GitHub repo](https://github.com/Pythagora-io/credit-based-backend-gpt-pilot-example)
-- 📊 Stats:
- - **3185** lines of code
- - **104** files
- - **~3** days of work
-
-### SQLite db analytics app
-- 💬 [All prompts used (initial and for additional features)](https://github.com/Pythagora-io/gpt-pilot-sqlite-analysis-tool/tree/main/prompts)
-- ▶️ [Video overview of app features](https://youtu.be/7t-Q2e7QsbE)
-- 💻️ [GitHub repo](https://github.com/Pythagora-io/gpt-pilot-sqlite-analysis-tool)
-- 📊 Stats:
- - **730** lines of code
- - **9** files
- - **6** hours of work
-
-## Simple Examples
-### 📱 Real-time chat app
-- 💬 Prompt: `A simple chat app with real-time communication`
-- ▶️ [Video of the app creation process](https://youtu.be/bUj9DbMRYhA)
-- 💻️ [GitHub repo](https://github.com/Pythagora-io/gpt-pilot-chat-app-demo)
-
-
-### 📝 Markdown editor
-- 💬 Prompt: `Build a simple markdown editor using HTML, CSS, and JavaScript. Allow users to input markdown text and display the formatted output in real-time.`
-- ▶️ [Video of the app creation process](https://youtu.be/uZeA1iX9dgg)
-- 💻️ [GitHub repo](https://github.com/Pythagora-io/gpt-pilot-demo-markdown-editor.git)
-
-
-### ⏱️ Timer app
-- 💬 Prompt: `Create a simple timer app using HTML, CSS, and JavaScript that allows users to set a countdown timer and receive an alert when the time is up.`
-- ▶️ [Video of the app creation process](https://youtu.be/CMN3W18zfiE)
-- 💻️ [GitHub repo](https://github.com/Pythagora-io/gpt-pilot-timer-app-demo)
# 🏗 How GPT Pilot works?
Here are the steps GPT Pilot takes to create an app:
-
-
1. You enter the app name and the description.
2. **Product Owner agent** like in real life, does nothing. :)
3. **Specification Writer agent** asks a couple of questions to understand the requirements better if project description is not good enough.
@@ -215,9 +202,6 @@ Here are the steps GPT Pilot takes to create an app:
10. **Debugger agent** hate to see him, but he is your best friend when things go south.
11. **Technical Writer agent** writes documentation for the project.
-
-
-
# 🕴How's GPT Pilot different from _Smol developer_ and _GPT engineer_?
@@ -229,9 +213,6 @@ Here are the steps GPT Pilot takes to create an app:
# 🍻 Contributing
If you are interested in contributing to GPT Pilot, I would be more than happy to have you on board and also help you get started. Feel free to ping [zvonimir@pythagora.ai](mailto:zvonimir@pythagora.ai), and I'll help you get started.
-## 🔬️ Research
-Since this is a research project, there are many areas that need to be researched on both practical and theoretical levels. We're happy to hear how the entire GPT Pilot concept can be improved. For example, maybe it would work better if we structured functional requirements differently, or maybe technical requirements need to be specified in a different way.
-
## 🖥 Development
Other than the research, GPT Pilot needs to be debugged to work in different scenarios. For example, we realized that the quality of the code generated is very sensitive to the size of the development task. When the task is too broad, the code has too many bugs that are hard to fix, but when the development task is too narrow, GPT also seems to struggle in getting the task implemented into the existing code.
diff --git a/media/backed-by-YC-black.png b/media/backed-by-YC-black.png
new file mode 100755
index 000000000..ff02e0936
Binary files /dev/null and b/media/backed-by-YC-black.png differ
diff --git a/media/backed-by-YC-white.png b/media/backed-by-YC-white.png
new file mode 100755
index 000000000..41432cfdf
Binary files /dev/null and b/media/backed-by-YC-white.png differ