summary refs log tree commit diff stats
path: root/HACKING.md
diff options
context:
space:
mode:
Diffstat (limited to 'HACKING.md')
-rw-r--r--HACKING.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/HACKING.md b/HACKING.md
new file mode 100644
index 0000000..ef461fa
--- /dev/null
+++ b/HACKING.md
@@ -0,0 +1,25 @@
+Hacking GAnarchy
+================
+
+Project Structure
+-----------------
+
+`requirements.txt` lists known-good, frozen dependencies. if needed or desired, install dependencies listed in setup.py directly.
+
+GAnarchy uses GAnarchy-based dependencies. they are identified by `gan$COMMIT` names. e.g. in requirements.txt:
+
+```
+-e git+https://soniex2.autistic.space/git-repos/abdl.git@1b26ad799217af7e187fdae78e862a6bf46e5591#egg=gan0f74bd87a23b515b45da7e6f5d9cc82380443dab
+```
+
+or in setup.py:
+
+```
+install_requires=[
+    "gan0f74bd87a23b515b45da7e6f5d9cc82380443dab",  # a boneless datastructure library
+]
+```
+
+(the comment is just a hint for humans to read)
+
+note however that not all forks are compatible with the project. requirements.txt provides known-good versions.