typeable/obelisk
1
0
Fork 0
mirror of https://github.com/typeable/obelisk.git synced 2024-11-20 10:50:08 +03:00
Code Issues Packages Projects Releases Wiki Activity

contributing: Improve dev env docs

Browse Source
This commit is contained in:
Elliot Cameron 2020-06-05 17:43:02 -04:00
parent c3c5684620
commit f73c6e9f6d
No known key found for this signature in database
GPG Key ID: 6ABB57E3D52B0628
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -82,31 +82,38 @@ The readme is the first place a lot of people look for information about the rep
## Development Environment
You can use `ghcid` for live feedback as you develop Obelisk libraries. To launch `ghcid` for `lib/backend` project, for example:
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
```bash
nix-shell -A obeliskEnvs.obelisk-backend --run "cd lib/backend && ghcid"
cd skeleton
ob run
```
Or to launch `ghcid` for `lib/command` project:
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.
For other libraries like `obelisk-command` you can use `ghcid`. To launch `ghcid` for `lib/command` you can run
```bash
nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid"
```
To re-install `ob` from source do
### Building `ob` for testing
To re-install `ob` from source globally you can do
```bash
nix-env -f /path/to/obelisk -iA command
```
You can also open a shell with the local version of `ob` available on your `PATH`:
You can also open a shell with the local version of `ob` available on your `$PATH`:
```bash
nix run -f /path/to/obelisk command
```
### Hacking on Obelisk from within an Obelisk project
Note that `ob` will defer to the version found in your project's `.obelisk/impl` directory. To update that version specifically:
`ob` will defer to the version found in your project's `.obelisk/impl` directory. To work on that version specifically:
```bash
ob thunk unpack ./.obelisk/impl