initHEADmaster

1 files changed, 30 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3065c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+see CHANGELOG.md
+
+to run without nix:
+- get build tools:
+    - with apt: `apt install cabal-install ghc git`
+- get source code: `git clone https://git.mtgmonkey.net/Andromeda/hs-game --depth 1; cd hs-game`
+- get dependencies
+    - with apt on x86-64: `apt install g++-x86-64_linux-gnu libgl-dev libx11-dev libxi-dev libxrandr-dev libxxf86vm-dev libxcursor-dev libxinerama-dev libglu1-mesa-dev`
+- run with `cabal run` or build with `cabal build`
+
+to run with nix:
+`nix run git+https://git.mtgmonkey.net/Andromeda/hs-game`
+
+to enter nix development shell:
+`nix develop git+https://git.mtgmonkey.net/Andromeda/hs-game`
+
+build tested on
+- nix
+- Kubuntu 25.10
+
+to release:
+- update CHANGELOG.md with new version
+- update version in hs-game.cabal
+- update version in flake.nix
+- check that it builds
+- `git add -A`
+- `git status` make sure there aren't random files
+- `git status -v` make sure all additions are in CHANGELOG.md
+- double check that flake, .cabal, and CHANGELOG.md all have the same version
+- release