renaming readme so that github pages serves index.html from root
This commit is contained in:
10
README.txt
Normal file
10
README.txt
Normal file
@@ -0,0 +1,10 @@
|
||||
Installation
|
||||
|
||||
1. brew install mkdocs
|
||||
2. pip install mkdocs-material
|
||||
3. pip install fontawesome_markdown
|
||||
|
||||
To build, navigate to the root of this repo and run:
|
||||
mkdocs build --clean
|
||||
|
||||
Note that the readme has been renamed to README.txt to prevent github pages from considering it to be the index by default!
|
Reference in New Issue
Block a user