Skip to content

Commit 38f86eb

Browse files
committed
update building instructions
1 parent 37cd5c2 commit 38f86eb

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
.vscode/
1+
.vscode/
2+
dist/

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,25 @@ Class & function documentation is built automatically from [the Geode source cod
1010

1111
The docs are built using [Flash](https://github.com/hjfod/flash). To build the docs, you need Flash, along with [CMake](https://cmake.org/install/) and [Clang](https://clang.llvm.org/).
1212

13+
To build the docs, you first need to clone Geode, and then clone the docs inside the Geode root, for a folder structure like this:
14+
15+
```
16+
geode/
17+
docs/
18+
<docs files>
19+
<geode files>
20+
```
21+
22+
For example, you can do this with the following commands:
23+
24+
```
25+
git clone https://github.com/geode-sdk/geode
26+
cd geode
27+
git clone https://github.com/geode-sdk/docs
28+
```
29+
30+
Alternatively, you can symlink your local copy of the docs folder to your local copy of the Geode folder.
31+
1332
After building Flash from source using Cargo or installing the latest release, you can build the docs with the following command:
1433

1534
```

0 commit comments

Comments
 (0)