.

Author: srush

docs/arch.png

@@ -3,19 +3,23 @@
 
 #
 
-Commit-0 is a real-world AI coding challenge.
-Can your agent generate a working library from commit 0?
+## Overview
+
+Commit-0 is a from scratch AI coding challenge.
+Can you create a library from commit 0?
 
 The benchmark consists of 57 core Python libraries.
-Libraries are selected based on:
+The challenge is to rebuild these libraries and
+pass their unit tests.  All libraries have:
 
-* Significant unit-test coverage
+* Significant test coverage
 * Detailed specification and documentation
 * Lint and type checking
 
-The [commit0 tool](setup) allows you to:
+Commit-0 is an interactive environment that makes it easy
+to design and test new agents. You can:
 
-* Efficiently run interactive tests in isolated environemnts
+* Efficiently run tests in isolated environemnts
 * Distribute testing and development across cloud systems
 * Track and log all changes made throughout.
 
@@ -25,6 +29,14 @@ To install run:
 pip install commit0
 ```
 
+## Architecture
+
+![](arch.png)
+
+
+![](commit0.gif)
+
+## Libraries
 
 |  | Name |  Repo | Commit0 | Tests |  |
 |--|--------|-------|----|----|------|

docs/commit0.gif

@@ -44,3 +44,40 @@ you can commit to the branch and call with the --branch command.
 ```bash
 commit0 test simpy tests/test_event.py::test_succeed --branch my_branch
 ```
+
+## Local Mode
+
+To run in local mode you first be sure that you have [docker tools](https://docs.docker.com/desktop/install/mac-install/)
+installed. On Debian systems:
+
+```bash
+apt install docker
+```
+
+To get started, run the `setup` command with the dataset
+split that you are interested in working with.
+We'll start with the `lite` split.
+
+
+```bash
+commit0 setup lite
+```
+
+This will install a clone the code for subset of libraries to your `repos/` directory.
+
+Next run the `build` command which will configure Docker containers for
+each of the libraries with isolated virtual environments. The command uses the
+[uv](https://github.com/astral-sh/uv) library for efficient builds.
+
+```bash
+commit0 build
+```
+
+The main operation you can do with these enviroments is to run tests.
+Here we run [a test](https://github.com/commit-0/simpy/blob/master/tests/test_event.py#L11) in the `simpy` library.
+
+```bash
+commit0 test simpy tests/test_event.py::test_succeed
+```
+
+See [distributed setup](/setupdist) for more commands.

docs/index.md

@@ -33,4 +33,4 @@ Here we run [a test](https://github.com/commit-0/simpy/blob/master/tests/test_ev
 commit0 test simpy tests/test_event.py::test_succeed
 ```
 
-See [distributed setup](setupdist) for more commands.
+See [distributed setup](/setupdist) for more commands.

docs/setupdist.md

@@ -3,10 +3,9 @@ site_name: ""
 docs_dir: docs
 nav:
   - Home: index.md
-  - Distributed: setupdist.md
-  - Local: setuplocal.md
-  - Extending: repos.md
-  - About: about.md
+  - Commit0: setupdist.md
+  - Agent: agent.md
+  - API: api.md
 theme:
   name: material
   logo: "logo2.webp"
@@ -17,5 +16,4 @@ extra_css:
 markdown_extensions:
   - pymdownx.inlinehilite
   - pymdownx.snippets
-  - pymdownx.superfences
   - pymdownx.highlight