Skip to content

Commit e5c20de

Browse files
committed
Add Hacking and Getting Help to the README
1 parent 7ffa180 commit e5c20de

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,29 @@ mainLoop w = do
110110
where
111111
untilNothingM m = m >>= maybe (return ()) (\_ -> untilNothingM m)
112112
```
113+
114+
# Hacking
115+
116+
If you would like to help `dear-imgui`, here's how you can get started.
117+
118+
The best path to development is using
119+
[Nix](https://nixos.org/guides/install-nix.html). Once you have Nix installed
120+
(either in your operating system, or by running NixOS), you can enter a
121+
development shell:
122+
123+
```
124+
$ nix-shell
125+
```
126+
127+
You should now be in a `bash` shell where you can run `cabal build all`,
128+
`cabal run readme`, etc.
129+
130+
If you experience any difficulties, please don't hesistate to raise an issue.
131+
132+
# Getting Help
133+
134+
Feel free to raise bugs, questions and feature requests on the GitHub issue
135+
tracker.
136+
137+
We have a Matrix room at
138+
[`#dear-imgui.hs:ocharles.org.uk`](https://matrix.to/#/#dear-imgui.hs:ocharles.org.uk).

0 commit comments

Comments
 (0)