Drezil/dear-imgui.hs
1
0
Fork 0
mirror of https://github.com/Drezil/dear-imgui.hs.git synced 2024-11-22 08:56:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Hacking and Getting Help to the README

Browse Source
This commit is contained in:
Ollie Charles 2021-01-25 17:53:59 +00:00
parent 7ffa180ad8
commit e5c20de7de
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -110,3 +110,29 @@ mainLoop w = do
where
untilNothingM m = m >>= maybe (return ()) (\_ -> untilNothingM m)
```
# Hacking
If you would like to help `dear-imgui`, here's how you can get started.
The best path to development is using
[Nix](https://nixos.org/guides/install-nix.html). Once you have Nix installed
(either in your operating system, or by running NixOS), you can enter a
development shell:
```
$ nix-shell
```
You should now be in a `bash` shell where you can run `cabal build all`,
`cabal run readme`, etc.
If you experience any difficulties, please don't hesistate to raise an issue.
# Getting Help
Feel free to raise bugs, questions and feature requests on the GitHub issue
tracker.
We have a Matrix room at
[`#dear-imgui.hs:ocharles.org.uk`](https://matrix.to/#/#dear-imgui.hs:ocharles.org.uk).