DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Do not include the source folder in Doxygen, tidy up README.md

Browse Source
This commit is contained in:
fincs 2015-10-10 02:04:16 +02:00
parent 839289378b
commit 3cb20a965b
2 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,24 +1,21 @@
ctrulib # ctrulib
=======
CTR User Library 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. 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. 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. 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 This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any warranty. In no event will the authors be held liable for any

2
libctru/Doxyfile
View File

@ -743,7 +743,7 @@ WARN_LOGFILE =
# spaces. # spaces.
# Note: If this tag is empty the current directory is searched. # 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 # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses