add some semblance of guide

This commit is contained in:
2025-09-21 13:49:07 +02:00
parent 47f5ad920a
commit 40dc3247ef

View File

@@ -1,3 +1,21 @@
# St Steamus Prime
A steam family optimizer
## How to develop
Frankly we are not quite sure.
The flake here sets up a development environment including postgres. You can use it with
`nix develop --impure`, and then running `devenv up`.
This process manager thing will eat that shell session, so you have to open another one to acutally develop..
Don't forget to run `nix develop --impure` in that new session as well!
(or use direnv to do it automatically)
After that you can enter the st_steamus_prime subdirectory and run.
* `mix deps.get` to download the dependencies.
* `mix phx.server` to run the development server