]> Chaos Git - corbenik/ctrulib.git/commitdiff
Do not include the source folder in Doxygen, tidy up README.md
authorfincs <fincs.alt1@gmail.com>
Sat, 10 Oct 2015 00:04:16 +0000 (02:04 +0200)
committerfincs <fincs.alt1@gmail.com>
Sat, 10 Oct 2015 00:04:16 +0000 (02:04 +0200)
README.md
libctru/Doxyfile

index 59d82615edb4aec7a5c1478f2aa000d8a2a3ed69..e5d62341119112d0c635483a157adc34e4b26637 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,21 @@
-ctrulib
-=======
+# ctrulib
 
 CTR User Library
 
-library for writing user mode arm11 code for the 3DS (CTR)
+Library for writing user mode arm11 code for the 3DS (CTR)
 
-the goal with this is to create a very straightforward interface with the 3DS's OS.
-it is not meant to provide higher level functions; to put things in perspective, the purpose of ctrulib would be to sit between the OS and a possible port of SDL rather than replace it.
+The goal with this is to create a very straightforward interface with the 3DS's OS.
+It is not meant to provide higher level functions; to put things in perspective, the purpose of ctrulib would be to sit between the OS and a possible port of SDL rather than replace it.
 
-setup
-=======
+# Setup
 
-ctrulib is just a library and needs a toolchain to function. we built ctrulib to be used in conjunction with devkitARM. you may find instructions on how to install devkitARM here : http://devkitpro.org/wiki/Getting_Started
+ctrulib is just a library and needs a toolchain to function. We built ctrulib to be used in conjunction with devkitARM. You may find instructions on how to install devkitARM on [the devkitPro Wiki](http://devkitpro.org/wiki/Getting_Started).
 
-The most recent devkitARM (r43) includes 3DS support and a prebuilt libctru.
+The most recent devkitARM (r44) includes 3DS support and a prebuilt libctru.
 
 To keep up to date with the most recent changes you'll want to checkout ctrulib, build it and install it.
 
-license
-=======
+# License
 
   This software is provided 'as-is', without any express or implied
   warranty.  In no event will the authors be held liable for any
index ce776ec1ae78483900b8bb368f7434b817031a62..cc072ed82c5b30ccaca0b639248b1fb614d37cab 100644 (file)
@@ -743,7 +743,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = source include ../README.md
+INPUT                  = include ../README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses