README.ds
changeset 5515 0fcf231a6e74
parent 5430 1b318d81c85f
child 6251 3e8c673cad58
--- a/README.ds	Fri Mar 25 14:45:04 2011 -0700
+++ b/README.ds	Sat Mar 26 21:26:05 2011 -0700
@@ -17,9 +17,9 @@
 After setting the devkitpro environment, cd into your SDL directory and type:
   make -f Makefile.ds
 
-This will compile and install the library and headers into the proper libnds
-directories. Additionnaly it will compile several tests that you can run
-either on the DS or with desmume. For instance:
+This will compile and install the library and headers into the
+devkitpro's portlibs directory. Additionnaly it will compile several
+tests that you can run either on the DS or with desmume. For instance:
   desmume test/nds-test-progs/general/general.nds
 
 -Notes-
@@ -27,7 +27,7 @@
 * The port is very basic and incomplete:
   - SDL currently has to be compiled for either framebuffer mode or render mode.
      See USE_HW_RENDERER in Makefile.ds.
-  - some optionnal renderer functions are not implemented.
+  - some optional renderer functions are not implemented.
 
 -Limitations-
 * in hardware renderer mode, don't load too many textures. The internal format is
@@ -36,4 +36,24 @@
 * the screen size is 256 x 384. Anything else won't work.
 * there is no 8 bits/pixel mode because SDL 1.3 doesn't support palettes.
 
+-Joystick mapping-
+The Joystick presented to SDL has 2 axes and 8 buttons
 
+ KEY      | Code
+  A       |   0
+  B       |   1
+  X       |   2
+  Y       |   3
+  L       |   4
+  R       |   5
+  select  |   6
+  start   |   7
+
+ Left-right is axe 0.
+ Up-down is axe 1.
+
+-Mouse mapping-
+todo
+
+-Examples-
+Due to memory limitations, to be able to successfully run the testscale example, sample.bmp must be resized to 256x105.