From e76fecc4ed1c21ec097dc08fc848e577ee31c088 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Tue, 29 Jul 2014 08:04:15 -0700 Subject: [PATCH] Moved documentation to docs, recreated a simple README.txt, fixed build --- INSTALL.txt | 8 ++++---- doc/README-SDL.md => README-SDL.txt | 0 README.txt | 21 +++++++++++++++++++++ {doc => docs}/README-android.md | 0 {doc => docs}/README-cmake.md | 0 {doc => docs}/README-directfb.md | 0 {doc => docs}/README-dynapi.md | 0 {doc => docs}/README-gesture.md | 0 {doc => docs}/README-hg.md | 0 {doc => docs}/README-ios.md | 0 {doc => docs}/README-linux.md | 0 {doc => docs}/README-macosx.md | 0 {doc => docs}/README-nacl.md | 0 {doc => docs}/README-pandora.md | 0 {doc => docs}/README-platforms.md | 0 {doc => docs}/README-porting.md | 0 {doc => docs}/README-psp.md | 0 {doc => docs}/README-raspberrypi.md | 0 {doc => docs}/README-touch.md | 0 {doc => docs}/README-wince.md | 0 {doc => docs}/README-windows.md | 0 {doc => docs}/README-winrt.md | 0 {doc => docs}/README.md | 0 {doc => docs}/doxyfile | 0 24 files changed, 25 insertions(+), 4 deletions(-) rename doc/README-SDL.md => README-SDL.txt (100%) create mode 100644 README.txt rename {doc => docs}/README-android.md (100%) rename {doc => docs}/README-cmake.md (100%) rename {doc => docs}/README-directfb.md (100%) rename {doc => docs}/README-dynapi.md (100%) rename {doc => docs}/README-gesture.md (100%) rename {doc => docs}/README-hg.md (100%) rename {doc => docs}/README-ios.md (100%) rename {doc => docs}/README-linux.md (100%) rename {doc => docs}/README-macosx.md (100%) rename {doc => docs}/README-nacl.md (100%) rename {doc => docs}/README-pandora.md (100%) rename {doc => docs}/README-platforms.md (100%) rename {doc => docs}/README-porting.md (100%) rename {doc => docs}/README-psp.md (100%) rename {doc => docs}/README-raspberrypi.md (100%) rename {doc => docs}/README-touch.md (100%) rename {doc => docs}/README-wince.md (100%) rename {doc => docs}/README-windows.md (100%) rename {doc => docs}/README-winrt.md (100%) rename {doc => docs}/README.md (100%) rename {doc => docs}/doxyfile (100%) diff --git a/INSTALL.txt b/INSTALL.txt index ce77664c99459..2df10bdd70bb8 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -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/ diff --git a/doc/README-SDL.md b/README-SDL.txt similarity index 100% rename from doc/README-SDL.md rename to README-SDL.txt diff --git a/README.txt b/README.txt new file mode 100644 index 0000000000000..84c335c2bd44a --- /dev/null +++ b/README.txt @@ -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) diff --git a/doc/README-android.md b/docs/README-android.md similarity index 100% rename from doc/README-android.md rename to docs/README-android.md diff --git a/doc/README-cmake.md b/docs/README-cmake.md similarity index 100% rename from doc/README-cmake.md rename to docs/README-cmake.md diff --git a/doc/README-directfb.md b/docs/README-directfb.md similarity index 100% rename from doc/README-directfb.md rename to docs/README-directfb.md diff --git a/doc/README-dynapi.md b/docs/README-dynapi.md similarity index 100% rename from doc/README-dynapi.md rename to docs/README-dynapi.md diff --git a/doc/README-gesture.md b/docs/README-gesture.md similarity index 100% rename from doc/README-gesture.md rename to docs/README-gesture.md diff --git a/doc/README-hg.md b/docs/README-hg.md similarity index 100% rename from doc/README-hg.md rename to docs/README-hg.md diff --git a/doc/README-ios.md b/docs/README-ios.md similarity index 100% rename from doc/README-ios.md rename to docs/README-ios.md diff --git a/doc/README-linux.md b/docs/README-linux.md similarity index 100% rename from doc/README-linux.md rename to docs/README-linux.md diff --git a/doc/README-macosx.md b/docs/README-macosx.md similarity index 100% rename from doc/README-macosx.md rename to docs/README-macosx.md diff --git a/doc/README-nacl.md b/docs/README-nacl.md similarity index 100% rename from doc/README-nacl.md rename to docs/README-nacl.md diff --git a/doc/README-pandora.md b/docs/README-pandora.md similarity index 100% rename from doc/README-pandora.md rename to docs/README-pandora.md diff --git a/doc/README-platforms.md b/docs/README-platforms.md similarity index 100% rename from doc/README-platforms.md rename to docs/README-platforms.md diff --git a/doc/README-porting.md b/docs/README-porting.md similarity index 100% rename from doc/README-porting.md rename to docs/README-porting.md diff --git a/doc/README-psp.md b/docs/README-psp.md similarity index 100% rename from doc/README-psp.md rename to docs/README-psp.md diff --git a/doc/README-raspberrypi.md b/docs/README-raspberrypi.md similarity index 100% rename from doc/README-raspberrypi.md rename to docs/README-raspberrypi.md diff --git a/doc/README-touch.md b/docs/README-touch.md similarity index 100% rename from doc/README-touch.md rename to docs/README-touch.md diff --git a/doc/README-wince.md b/docs/README-wince.md similarity index 100% rename from doc/README-wince.md rename to docs/README-wince.md diff --git a/doc/README-windows.md b/docs/README-windows.md similarity index 100% rename from doc/README-windows.md rename to docs/README-windows.md diff --git a/doc/README-winrt.md b/docs/README-winrt.md similarity index 100% rename from doc/README-winrt.md rename to docs/README-winrt.md diff --git a/doc/README.md b/docs/README.md similarity index 100% rename from doc/README.md rename to docs/README.md diff --git a/doc/doxyfile b/docs/doxyfile similarity index 100% rename from doc/doxyfile rename to docs/doxyfile