on master help sign in
Merge pull request #37 from obsidiansystems/obelisk-ghcid-dev

Developer documentation

commit848086d069a1a9d3847f2c82d5f99b7f0ef381fb authorRyan Trinkle <ryan.trinkle@gmail.com> dateFri 1 Jun 2018, 11:47 (8 years ago) parent9fce2bd5c1cfbb
1 file changed+14
README.md+14
README.md+14
@@ -26,6 +26,20 @@ Obelisk provides an easy way to develop and deploy your [Reflex](https://github.
2626 ```
27271. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`
2828
29+### Contributing to Obelisk
30+
31+When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:
32+
33+```
34+nix-shell -A obelisk.obelisk-backend.env --run "cd lib/backend && ghcid -c 'cabal new-repl'"
35+```
36+
37+Or to launch ghcid for `lib/command` project:
38+
39+```
40+nix-shell -A obelisk.obelisk-command.env --run "cd lib/command && ghcid -c 'cabal new-repl'"
41+```
42+
2943### Accessing private repositories
3044To allow the Nix builder to access private git repositories, follow these steps:
3145