Skip to content

Commit 8cd5c24

Browse files
authored
Update README.md
1 parent 598a597 commit 8cd5c24

File tree

1 file changed

+1
-40
lines changed

1 file changed

+1
-40
lines changed

README.md

+1-40
Original file line numberDiff line numberDiff line change
@@ -16,43 +16,4 @@ Very similar to [https://github.com/pyimgui/pyimgui](pyimgui/pyimugui) except bu
1616

1717
### Development
1818

19-
Prerequisites:
20-
- clang-format for generating enums
21-
- macOS: `brew install clang-format`
22-
23-
MacOS:
24-
25-
```
26-
python3 -m venv .venv
27-
. .venv/bin/activate
28-
pip install git+https://github.com/wjakob/nanobind 'scikit-build-core[pyproject]' click glfw pyopengl numpy requests
29-
pip install --no-build-isolation -ve .
30-
python gen/gen_nb_enums.py > src/im_enums.inl
31-
```
32-
33-
Windows:
34-
35-
```
36-
python3 -m venv .venv
37-
.venv\Scripts\activate.bat
38-
pip install git+https://github.com/wjakob/nanobind scikit-build-core[pyproject] click glfw pyopengl numpy
39-
pip install --no-build-isolation -ve .
40-
python gen\gen_nb_enums.py > src\im_enums.inl
41-
```
42-
43-
#### Docs build with filewatching
44-
45-
```
46-
npx nodemon -w gen -w docs/template.html -w docs/apiref.md -x python gen/build_docs.py --pyi-file src/slimgui/slimgui_ext.pyi --output docs/index.html docs/apiref.md
47-
```
48-
49-
#### Updating imgui and cimgui metainfo when upgrading imgui
50-
51-
NOTE NOTE! imconfig.h contains slimgui changes! Review after updating imgui.
52-
53-
```
54-
- git clone https://github.com/cimgui/cimgui
55-
- update the imgui folder in the cimgui checkout with an imgui source release
56-
- cd generator && ./generator
57-
- dump the generator/output contents into gen/cimgui
58-
```
19+
- [DEVELOPMENT.md](./DEVELOPMENT.md)

0 commit comments

Comments
 (0)