update README

carderne · Mar 20, 2024 · eed53bc · eed53bc
1 parent 241eabb
commit eed53bc
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 36 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
diff --git a/README.md b/README.md
@@ -187,18 +187,16 @@ pip uninstall signal-export
 ```bash
 git clone https://github.com/carderne/signal-export.git
 cd signal-export
-pip install -e .[dev,sql]
-pre-commit install
+rye sync --no-lock
 ```
 
-Run tests with:
+Various dev commands:
 ```bash
-make test
-```
-
-And check types with:
-```bash
-mypy sigexport/
+rye fmt         # format
+rye lint        # lint
+rye run check   # typecheck
+rye run test    # test
+rye run sig     # run signal-export
 ```
 
 ## Similar things

diff --git a/pyproject.toml b/pyproject.toml
@@ -2,7 +2,7 @@
 check = "pyright"
 build = "docker build --tag=carderne/sigexport:dev ."
 test = "pytest"
-run = "sigexport"
+sig = "sigexport"
 
 [project]
 name = "signal-export"