on master help sign in
contributing: Improve dev env docs
commitf73c6e9f6de11a9154588c6a33a01588188c969a authorElliot Cameron <eacameron@gmail.com> dateFri 5 Jun 2020, 17:43 (6 years ago) parentc3c5684
1 file changed+13−6
CONTRIBUTING.md+13−6
CONTRIBUTING.md+13−6
@@ -82,31 +82,38 @@ The readme is the first place a lot of people look for information about the rep
8282
8383## Development Environment
8484
85−You can use `ghcid` for live feedback as you develop Obelisk libraries. To launch `ghcid` for `lib/backend` project, for example:
85+There are two ways to get live compiler feedback while developing Obelisk libraries. For libraries that are dependencies of the `skeleton` application, the easiest way to get feedback is to
8686
8787```bash
88−nix-shell -A obeliskEnvs.obelisk-backend --run "cd lib/backend && ghcid"
88+cd skeleton
89+ob run
8990```
9091
91−Or to launch `ghcid` for `lib/command` project:
92+This `ob run` session only loads modules that are dependencies of the skeleton and `obelisk-run`. For example, `obelisk-asset` and `obelisk-route` are used by the skeleton.
93+
94+For other libraries like `obelisk-command` you can use `ghcid`. To launch `ghcid` for `lib/command` you can run
9295
9396```bash
9497nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid"
9598```
9699
97−To re-install `ob` from source do
100+### Building `ob` for testing
101+
102+To re-install `ob` from source globally you can do
103+
98104```bash
99105nix-env -f /path/to/obelisk -iA command
100106```
101107
102−You can also open a shell with the local version of `ob` available on your `PATH`:
108+You can also open a shell with the local version of `ob` available on your `$PATH`:
103109
104110```bash
105111nix run -f /path/to/obelisk command
106112```
107113
114+### Hacking on Obelisk from within an Obelisk project
108115
109−Note that `ob` will defer to the version found in your project's `.obelisk/impl` directory. To update that version specifically:
116+`ob` will defer to the version found in your project's `.obelisk/impl` directory. To work on that version specifically:
110117
111118```bash
112119ob thunk unpack ./.obelisk/impl