summaryrefslogtreecommitdiff
path: root/Omni/Bild
diff options
context:
space:
mode:
authorBen Sima <ben@bensima.com>2025-11-22 13:50:23 -0500
committerBen Sima <ben@bensima.com>2025-11-22 13:50:23 -0500
commit67dd152e40a3f08e5a7aaaaf4cc9b1122e6b6909 (patch)
treeb33f5faa4bb3520d49443008e30b996713493115 /Omni/Bild
parent6f4b2c97a24967508f3970b46999052fd1f44e67 (diff)
feat: implement t-1o2bkufixnc
I have successfully refactored `AGENTS.md` to be more concise by moving detailed documentation to separate README files in their respective namespaces. **Changes made:** 1. **Created `Omni/Task/README.md`**: Contains the detailed "Task Manager for AI Agents" documentation. 2. **Created `Omni/Bild/README.md`**: Contains the "Bild" build tool documentation and instructions for adding new dependencies. 3. **Created `Omni/Ide/README.md`**: Contains the "Development Tools" (run.sh, lint, etc.) and "Git Workflow" documentation. 4. **Updated `AGENTS.md`**: * Retained critical rules ("Important Rules for AI Agents"), "About Omnirepo", and "Coding Conventions". * Replaced the moved sections with a "Documentation" section containing links to the new README files. * Used relative paths for links to ensure portability. **Verification:** * Ran `bild --test Omni/Task.hs` and `bild --test Omni/Bild.hs` to ensure no regressions were introduced in the touched namespaces. The codebase is now cleaner with documentation distributed near the code it describes, and `AGENTS.md` is now a focused entry point for agents.
Diffstat (limited to 'Omni/Bild')
-rw-r--r--Omni/Bild/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/Omni/Bild/README.md b/Omni/Bild/README.md
new file mode 100644
index 0000000..e1c026c
--- /dev/null
+++ b/Omni/Bild/README.md
@@ -0,0 +1,40 @@
+# Bild
+
+`bild` is the universal build tool. It can build and test everything in the repo.
+
+Examples:
+```bash
+bild --test Omni/Bild.hs # Build and test a namespace
+bild --time 0 Omni/Cloud.nix # Build with no timeout
+bild --plan Omni/Test.hs # Analyze build without building
+```
+
+When the executable is built, the output will go to `_/bin`. Example:
+
+```bash
+# build the example executable
+bild Omni/Bild/Example.py
+# run the executable
+_/bin/example
+```
+
+## Adding New Dependencies
+
+### Python Packages
+
+To add a new Python package as a dependency:
+
+1. Add the package name to `Omni/Bild/Deps/Python.nix` (alphabetically sorted)
+2. Use it in your Python file with `# : dep <package-name>` comment at the top
+3. Run `bild <yourfile.py>` to build with the new dependency
+
+Example:
+```python
+# : out myapp
+# : dep stripe
+# : dep pytest
+import stripe
+```
+
+The package name must match the nixpkgs python package name (usually the PyPI name).
+Check available packages: `nix-env -qaP -A nixpkgs.python3Packages | grep <name>`