update docs + cleanups

deepsense-ai · Sep 17, 2024 · 81e7974 · 81e7974
1 parent 27aef5f
commit 81e7974
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -2,21 +2,19 @@
 
 Repository for internal experiment with our upcoming LLM framework.
 
+# Installation
 
-# Setup developer environment
+## Build from source
 
-To start, you need to setup your local machine.
+To build and run Ragbits from the source code:
 
-## Setup venv
-
-You need to setup virtual environment, simplest way is to run from project root directory:
+1. Requirements: [**uv**](https://docs.astral.sh/uv/getting-started/installation/) & [**python**](https://docs.astral.sh/uv/guides/install-python/) 3.10 or higher
+2. Install dependencies and run venv in editable mode:
 
 ```bash
 $ source ./setup_dev_env.sh
 ```
 
-This will create a new venv and install all packages from this repository in editable mode.
-
 ## Install pre-commit
 
 To ensure code quality we use pre-commit hook with several checks. Setup it by:

diff --git a/docker/precommit/Dockerfile b/docker/precommit/Dockerfile