diff options
| -rw-r--r-- | INSTALL.txt | 8 | ||||
| -rw-r--r-- | README-SDL.txt (renamed from doc/README-SDL.md) | 0 | ||||
| -rw-r--r-- | README.txt | 21 | ||||
| -rw-r--r-- | docs/README-android.md (renamed from doc/README-android.md) | 0 | ||||
| -rw-r--r-- | docs/README-cmake.md (renamed from doc/README-cmake.md) | 0 | ||||
| -rw-r--r-- | docs/README-directfb.md (renamed from doc/README-directfb.md) | 0 | ||||
| -rw-r--r-- | docs/README-dynapi.md (renamed from doc/README-dynapi.md) | 0 | ||||
| -rw-r--r-- | docs/README-gesture.md (renamed from doc/README-gesture.md) | 0 | ||||
| -rw-r--r-- | docs/README-hg.md (renamed from doc/README-hg.md) | 0 | ||||
| -rw-r--r-- | docs/README-ios.md (renamed from doc/README-ios.md) | 0 | ||||
| -rw-r--r-- | docs/README-linux.md (renamed from doc/README-linux.md) | 0 | ||||
| -rw-r--r-- | docs/README-macosx.md (renamed from doc/README-macosx.md) | 0 | ||||
| -rw-r--r-- | docs/README-nacl.md (renamed from doc/README-nacl.md) | 0 | ||||
| -rw-r--r-- | docs/README-pandora.md (renamed from doc/README-pandora.md) | 0 | ||||
| -rw-r--r-- | docs/README-platforms.md (renamed from doc/README-platforms.md) | 0 | ||||
| -rw-r--r-- | docs/README-porting.md (renamed from doc/README-porting.md) | 0 | ||||
| -rw-r--r-- | docs/README-psp.md (renamed from doc/README-psp.md) | 0 | ||||
| -rw-r--r-- | docs/README-raspberrypi.md (renamed from doc/README-raspberrypi.md) | 0 | ||||
| -rw-r--r-- | docs/README-touch.md (renamed from doc/README-touch.md) | 0 | ||||
| -rw-r--r-- | docs/README-wince.md (renamed from doc/README-wince.md) | 0 | ||||
| -rw-r--r-- | docs/README-windows.md (renamed from doc/README-windows.md) | 0 | ||||
| -rw-r--r-- | docs/README-winrt.md (renamed from doc/README-winrt.md) | 0 | ||||
| -rw-r--r-- | docs/README.md (renamed from doc/README.md) | 0 | ||||
| -rw-r--r-- | docs/doxyfile (renamed from doc/doxyfile) | 0 |
24 files changed, 25 insertions, 4 deletions
diff --git a/INSTALL.txt b/INSTALL.txt index ce77664c9..2df10bdd7 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 index 0630395e5..0630395e5 100644 --- a/doc/README-SDL.md +++ b/README-SDL.txt diff --git a/README.txt b/README.txt new file mode 100644 index 000000000..84c335c2b --- /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 index c061f95a7..c061f95a7 100644 --- a/doc/README-android.md +++ b/docs/README-android.md diff --git a/doc/README-cmake.md b/docs/README-cmake.md index b5daad908..b5daad908 100644 --- a/doc/README-cmake.md +++ b/docs/README-cmake.md diff --git a/doc/README-directfb.md b/docs/README-directfb.md index a7b542fa3..a7b542fa3 100644 --- a/doc/README-directfb.md +++ b/docs/README-directfb.md diff --git a/doc/README-dynapi.md b/docs/README-dynapi.md index 5669fd76e..5669fd76e 100644 --- a/doc/README-dynapi.md +++ b/docs/README-dynapi.md diff --git a/doc/README-gesture.md b/docs/README-gesture.md index fc8a093c7..fc8a093c7 100644 --- a/doc/README-gesture.md +++ b/docs/README-gesture.md diff --git a/doc/README-hg.md b/docs/README-hg.md index 27396327c..27396327c 100644 --- a/doc/README-hg.md +++ b/docs/README-hg.md diff --git a/doc/README-ios.md b/docs/README-ios.md index 62ec395d5..62ec395d5 100644 --- a/doc/README-ios.md +++ b/docs/README-ios.md diff --git a/doc/README-linux.md b/docs/README-linux.md index d9cf40fb9..d9cf40fb9 100644 --- a/doc/README-linux.md +++ b/docs/README-linux.md diff --git a/doc/README-macosx.md b/docs/README-macosx.md index ca6b7ee12..ca6b7ee12 100644 --- a/doc/README-macosx.md +++ b/docs/README-macosx.md diff --git a/doc/README-nacl.md b/docs/README-nacl.md index b664f05ee..b664f05ee 100644 --- a/doc/README-nacl.md +++ b/docs/README-nacl.md diff --git a/doc/README-pandora.md b/docs/README-pandora.md index e50e0c279..e50e0c279 100644 --- a/doc/README-pandora.md +++ b/docs/README-pandora.md diff --git a/doc/README-platforms.md b/docs/README-platforms.md index 3f1950a91..3f1950a91 100644 --- a/doc/README-platforms.md +++ b/docs/README-platforms.md diff --git a/doc/README-porting.md b/docs/README-porting.md index d93c65bd3..d93c65bd3 100644 --- a/doc/README-porting.md +++ b/docs/README-porting.md diff --git a/doc/README-psp.md b/docs/README-psp.md index 41fc9040a..41fc9040a 100644 --- a/doc/README-psp.md +++ b/docs/README-psp.md diff --git a/doc/README-raspberrypi.md b/docs/README-raspberrypi.md index de920cce1..de920cce1 100644 --- a/doc/README-raspberrypi.md +++ b/docs/README-raspberrypi.md diff --git a/doc/README-touch.md b/docs/README-touch.md index 5850b4f8f..5850b4f8f 100644 --- a/doc/README-touch.md +++ b/docs/README-touch.md diff --git a/doc/README-wince.md b/docs/README-wince.md index c543ed65d..c543ed65d 100644 --- a/doc/README-wince.md +++ b/docs/README-wince.md diff --git a/doc/README-windows.md b/docs/README-windows.md index 076b1556e..076b1556e 100644 --- a/doc/README-windows.md +++ b/docs/README-windows.md diff --git a/doc/README-winrt.md b/docs/README-winrt.md index ee3a30327..ee3a30327 100644 --- a/doc/README-winrt.md +++ b/docs/README-winrt.md diff --git a/doc/README.md b/docs/README.md index d538dca0d..d538dca0d 100644 --- a/doc/README.md +++ b/docs/README.md diff --git a/doc/doxyfile b/docs/doxyfile index 151fa896a..151fa896a 100644 --- a/doc/doxyfile +++ b/docs/doxyfile |