Skip to content

Commit 3e31724

Browse files
authored
Add development environment setup instructions
Added instructions for setting up a development environment using MKDocs.
1 parent 7f90fba commit 3e31724

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,26 @@ You agree that your code and articles are licensed **Creative Commons Zero**, an
3434

3535
Write the code to be proper **GLSL** or **OpenGL Shading Language**, in terms of syntax.
3636

37+
## Dev Environment
38+
39+
When writing articles, it's recommended to set up a development environment, so you can verify it works before submitting your changes. This is fairly straightfoward, as The Library Of Shaders uses MKDocs to generate the site.
40+
41+
First off, clone the repository into the folder you want it in.
42+
```
43+
git clone https://github.com/The-Library-Of-Shaders/the-library-of-shaders.github.io.git
44+
```
45+
You can also download the repository as a ZIP file and extract it, if you don't have the CLI for git.
46+
47+
Next, install the MkDocs Python package.
48+
```
49+
pip install mkdocs
50+
```
51+
52+
Finally, serve the site.
53+
```
54+
mkdocs serve
55+
```
56+
57+
You now have a local copy of the library running on your localhost.
3758

3859

0 commit comments

Comments
 (0)