a few doc tweaks

.github/CONTRIBUTING.md

@@ -26,16 +26,18 @@ To enforce this we use [`pre-commit`](https://pre-commit.com/) to run [`black`](
 
 ```bash
 $ pip install -r requirements.txt
-```
 
-And then install the `pre-commit` hooks with:
-```bash
+# And then install the `pre-commit` hooks with:
+
 $ pre-commit install
 
+# output:
 pre-commit installed at .git/hooks/pre-commit
-
 ```
 
+Or you could just run `make dev-install` to install the dependencies and the hooks!
+
+
 If you are not familiar with the concept of [git hooks](https://git-scm.com/docs/githooks) and/or [`pre-commit`](https://pre-commit.com/) please read the documentation to understand how they work.
 
 As an introduction of the actual workflow, here is an example of the process you will encounter when you make a commit:

README.md

@@ -15,16 +15,57 @@ GPT Engineer is made to be easy to adapt, extend, and make your agent learn how
 - Simplicity, all computation is "resumable" and persisted to the filesystem
 
 
+## Installation
+
+**Users**:
+
+We recommend installing from PyPi:
+```bash
+pip install gpt-engineer
+```
+This will make sure you are running the latest stable version.
+
+
+**Contributors/Developers**:
+
+If you plan on becoming a [contributor](.github/CONTRIBUTING.md) or if you just want to test/develop something on top of things,
+you can install from GitHub the bleeding version, aka the `main` branch:
+
+_(be aware this is a very active project and might be unstable at times)_
+
+```bash
+# use make (run make --help to see all commands available)
+make install
+
+# or
+
+make dev-install  # if you plan to contribute
+```
+
+If you know your way around Python project you can also install manually (make sure you are in a virtual environment):
+```
+pip install -r requirements.txt
+```
+
+
 ## Usage
 
 **Setup**:
-- `pip install -r requirements.txt`
-- `export OPENAI_API_KEY=[your api key]` with a key that has GPT4 access
+
+- setup your OpenAI API Key (with a key that has GPT4 access)
+```
+export OPENAI_API_KEY=[your api key]
+```
 
 **Run**:
-- Create a new empty folder with a `main_prompt` file in the `projects` folder (or copy the example folder `cp -r projects/example/ projects/my-new-project`)
+- Create a new empty folder with a `main_prompt` file in the `projects` folder or copy the example folder:
+```
+cp -r projects/example/ projects/my-new-project
+```
+
 - Fill in the `main_prompt` in your new folder
-- Run `python -m gpt_engineer.main my-new-project`
+
+- Run `make run my-new-project` or `python -m gpt_engineer.main my-new-project`
   - Optionally pass in `true` to delete the working files before running
 
 **Results**: