Moved documentation to docs, recreated a simple README.txt, fixed build

--HG--
rename : doc/README-SDL.md => README-SDL.txt
rename : doc/README-android.md => docs/README-android.md
rename : doc/README-cmake.md => docs/README-cmake.md
rename : doc/README-directfb.md => docs/README-directfb.md
rename : doc/README-dynapi.md => docs/README-dynapi.md
rename : doc/README-gesture.md => docs/README-gesture.md
rename : doc/README-hg.md => docs/README-hg.md
rename : doc/README-ios.md => docs/README-ios.md
rename : doc/README-linux.md => docs/README-linux.md
rename : doc/README-macosx.md => docs/README-macosx.md
rename : doc/README-nacl.md => docs/README-nacl.md
rename : doc/README-pandora.md => docs/README-pandora.md
rename : doc/README-platforms.md => docs/README-platforms.md
rename : doc/README-porting.md => docs/README-porting.md
rename : doc/README-psp.md => docs/README-psp.md
rename : doc/README-raspberrypi.md => docs/README-raspberrypi.md
rename : doc/README-touch.md => docs/README-touch.md
rename : doc/README-wince.md => docs/README-wince.md
rename : doc/README-windows.md => docs/README-windows.md
rename : doc/README-winrt.md => docs/README-winrt.md
rename : doc/README.md => docs/README.md
rename : doc/doxyfile => docs/doxyfile
This commit is contained in:
Sam Lantinga 2014-07-29 08:04:15 -07:00
parent 9509486801
commit 91bbc7d9fa
24 changed files with 25 additions and 4 deletions

View file

@ -9,7 +9,7 @@ To compile and install SDL:
* Run './configure; make; make install'
Mac OS X with Xcode:
* Read README-macosx.txt
* Read docs/README-macosx.md
Mac OS X from the command line:
* Run './configure; make; make install'
@ -18,13 +18,13 @@ To compile and install SDL:
* Run './configure; make; make install'
Android:
* Read README-android.txt
* Read docs/README-android.md
iOS:
* Read README-ios.txt
* Read docs/README-ios.md
Using Cmake:
* Read README-cmake.txt
* Read docs/README-cmake.md
2. Look at the example programs in ./test, and check out the online
documentation at http://wiki.libsdl.org/

21
README.txt Normal file
View file

@ -0,0 +1,21 @@
Simple DirectMedia Layer
(SDL)
Version 2.0
---
http://www.libsdl.org/
Simple DirectMedia Layer is a cross-platform development library designed
to provide low level access to audio, keyboard, mouse, joystick, and graphics
hardware via OpenGL and Direct3D. It is used by video playback software,
emulators, and popular games including Valve's award winning catalog
and many Humble Bundle games.
More extensive documentation is available in the docs directory, starting
with README.md
Enjoy!
Sam Lantinga (slouken@libsdl.org)