Browse Source

Added readme.txt and changed build output dir

master
Christopher 8 years ago
parent
commit
acbef128cd
  1. 6
      Docs/Doxyfile
  2. 22
      Docs/readme.txt

6
Docs/Doxyfile

@ -58,7 +58,7 @@ PROJECT_LOGO = /Users/Gregan/github/fungus/Docs/resources/header/logo_
# entered, it will be relative to the location where doxygen was started. If # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = ../Build/Doxygen OUTPUT_DIRECTORY = ../Build/Docs
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and # directories (in 2 levels) under the output directory of each output format and
@ -782,8 +782,8 @@ WARN_LOGFILE =
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = ../Assets/Fungus/Scripts \ INPUT = ../Assets/Fungus/Scripts \
fungus_lua.md \ top_pages/fungus_lua.md \
command_reference.md \ top_pages/command_reference.md \
./ ./
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files

22
Docs/readme.txt

@ -0,0 +1,22 @@
Building the Fungus documentation
=================================
1. Download and install Doxygen from http://www.doxygen.org
2. Run Doxygen and open the file called 'Doxyfile'
3. Click the Run tab and click the Run Doxygen button.
Doxygen will process all source code and markdown files and place the HTML documentation in Build/Docs.
Contributing
============
To add or change something in the documentation please submit a pull request via github.
License
=======
The Fungus documentation is licensed under the Creative Commons Attribution-NonCommercial License.
https://creativecommons.org/licenses/by-nc/3.0/
Loading…
Cancel
Save