diff --git a/README.md b/README.md index 2175d1f..2137978 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,31 @@ Tests * Run functional tests $ ./run_functional_tests +Making the Docs +=============== + +* Use Hugo ... so install it +* rm -rf docs/public (only do this if you are knowing what you do and why you would do this, it should only need to be done once and it's done so don't touch it) +* git subtree add --prefix docs/public git@github.com:RazortoothRTC/node-smile-server.git gh-pages --squash +* git subtree pull --prefix=docs/public +* Run hugo from docs dir +* git commit -a +* git subtree push --prefix=docs/public git@github.com:RazortoothRTC/node-smile-server.git gh-pages + +Updating the Docs +================ + +* git subtree pull --prefix=docs/public +* Update the docs +* Run hugo from docs dir (to generate the new doc changes) +* git commit -a +* git subtree push --prefix=docs/public git@github.com:RazortoothRTC/node-smile-server.git gh-pages + + Attributions ============ -* Flickr: https://www.flickr.com/photos/testrunbomber842/10053155455 \ No newline at end of file +* Flickr: https://www.flickr.com/photos/testrunbomber842/10053155455 +* Hugo (for Docs): +* Jquery: for everything else +* Node.js: Also, for making everything a little bit easier diff --git a/docs/public/community/contributing/index.html b/docs/public/community/contributing/index.html index 3624647..adea9db 100644 --- a/docs/public/community/contributing/index.html +++ b/docs/public/community/contributing/index.html @@ -4,9 +4,9 @@ Contributing to Epoch SMILE - - - + + + @@ -21,7 +21,7 @@ - + @@ -31,17 +31,17 @@ Getting Started @@ -49,30 +49,30 @@ User Guides @@ -82,11 +82,11 @@ Meta @@ -182,8 +182,8 @@

Building Epoch SMILE

Code licensed under the 3-Clause BSD License.
- - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + +