diff --git a/README b/README index 7fb976fcfb539bd28b682575b5225af676649946..d8aa22d272df7b1548c6c4bb9feda30288d85841 100644 --- a/README +++ b/README @@ -14,6 +14,10 @@ http://qgroundcontrol.org/credits * PLEASE NOTE: YOU NEED TO DOWNLOAD THE MAVLINK LIBRARY IN ORDER TO COMPILE THIS APPLICATION * ********************************************************************************************** +Documentation +============= +For gernerating documentation, refer to README in the doc directory. + Mac OS X ======== @@ -99,4 +103,3 @@ Windows XP/7: 6) Compile and edit in Visual Studio. If you need to add new files, add them to qgroundcontrol.pro and re-run `qmake -tp vc qgroundcontrol.pro` - diff --git a/doc/README b/doc/README new file mode 100644 index 0000000000000000000000000000000000000000..21c21f2a5ec000d01665a50deb0b024f37e42c5f --- /dev/null +++ b/doc/README @@ -0,0 +1,37 @@ +Linux/Mac OS X +============== +To install doxygen: +$sudo apt-get install doxygen + +If the above does not work go to: +http://www.stack.nl/~dimitri/doxygen/download.html for the correct download. + +Then go to the following website for inforamtion on the install: +http://www.stack.nl/~dimitri/doxygen/install.html + +Then to generate the html, run the following code while you are in the qgroundcontrol/doc directory: +$doxygen Doxyfile + +The html file index.html should be in doc/html unless you chenged the output directory. + +The other option for generating the documentation is to use the wizard: +$doxywizard & + +doxywizard information: +http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html + +Or go to the Doxygen Manual for information. + +Windows +======= +Go to the following website for the correct download and follow the wizard to install: +http://www.stack.nl/~dimitri/doxygen/download.html + +Run the wizard to generate the documentation. +Go to the website below or the Doxygen Manual for information on running doxywizard +http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html + +doxygen Manual +============== +http://www.stack.nl/~dimitri/doxygen/ +