[Tux4kids-commits] r56 - in tuxmath/trunk: . docs nsis

dbruce at alioth.debian.org dbruce at alioth.debian.org
Thu Mar 8 21:21:42 CET 2007


Author: dbruce
Date: 2006-10-31 17:33:07 +0000 (Tue, 31 Oct 2006)
New Revision: 56

Modified:
   tuxmath/trunk/configure.in
   tuxmath/trunk/docs/INSTALL.txt
   tuxmath/trunk/docs/README.txt
   tuxmath/trunk/docs/TODO.txt
   tuxmath/trunk/docs/changelog
   tuxmath/trunk/nsis/tuxmath.nsi
Log:
Updated docs


Modified: tuxmath/trunk/configure.in
===================================================================
--- tuxmath/trunk/configure.in	2006-10-30 16:44:31 UTC (rev 55)
+++ tuxmath/trunk/configure.in	2006-10-31 17:33:07 UTC (rev 56)
@@ -6,7 +6,7 @@
 AC_CANONICAL_HOST
 AC_CANONICAL_TARGET
 
-AM_INIT_AUTOMAKE(tuxmath, 0.98)
+AM_INIT_AUTOMAKE(tuxmath, 1.0)
 AM_CONFIG_HEADER(config.h)
 AM_MAINTAINER_MODE
 

Modified: tuxmath/trunk/docs/INSTALL.txt
===================================================================
--- tuxmath/trunk/docs/INSTALL.txt	2006-10-30 16:44:31 UTC (rev 55)
+++ tuxmath/trunk/docs/INSTALL.txt	2006-10-31 17:33:07 UTC (rev 56)
@@ -1,6 +1,6 @@
 INSTALL.txt for "Tux, Of Math Command" (aka "Tuxmath")
 
-October 17, 2006
+October 31, 2006
 
 
 Requirements
@@ -21,7 +21,7 @@
       IRIX
       FreeBSD
       BeOS
-    However, I do not know if anyone has done a build on these systems
+    However, I do not know if anyone has done a current build on these systems.
 
   CPU
   ---
@@ -122,7 +122,7 @@
   ----------
     Compiling the Program
     ---------------------
-      Tuxmath now uses the Gnu autoconf/automake tools, meaning that the
+      Tuxmath now uses the Gnu Autoconf/Automake tools, meaning that the
       complete build and installation process just involves typing the
       following at a shell prompt within the /trunk directory of the source
       code tree:
@@ -178,26 +178,24 @@
          ./cross-configure.sh --with-sdl-prefix
          ./cross-make.sh
 
-      You should now have the tuxmath.exe executable - for reasons I do not yet quite
-      understand, it gets created in src rather than trunk. Before you can use makensis
-      to create the win32 installer, you need to copy it into the trunk/mingw32 directory,
+      You should now have the tuxmath.exe executable in the trunk/mingw32 directory,
       which should have been created by cross-make.sh.  Also, you need to have a directory
       containing all of the dlls that will need to be packaged into the installer.  The
       Makefile expects them to be in NSI_DLL_DIR, which is set to  ~/tuxmath_dll. On my
       machine, this contains:
 
       dbruce at debian:~/tuxmath_dll$ ls
-      SDL.dll        jpeg.dll      ogg.dll     vorbisfile.dll
+      SDL.dll        jpeg.dll      
       SDL_image.dll  libpng12.dll  smpeg.dll   zlib1.dll
-      SDL_mixer.dll  libtiff.dll   vorbis.dll
+      SDL_mixer.dll  libtiff.dll   
 
       (Note - this has mostly the same files as the cross-tools lib directory - it is most
-      likely possible to eliminate this redundancy in some way).
+      likely possible to eliminate this redundancy in some way.).
 
       6. From the trunk dir, run:
          ./cross-make.sh nsis
 
-      This should create the windows installer file ("tuxmath-0.96-win32-installer.exe")
+      This should create the windows installer file ("tuxmath-1.0-win32-installer.exe")
       under trunk.
 
       Installation on Windows:

Modified: tuxmath/trunk/docs/README.txt
===================================================================
--- tuxmath/trunk/docs/README.txt	2006-10-30 16:44:31 UTC (rev 55)
+++ tuxmath/trunk/docs/README.txt	2006-10-31 17:33:07 UTC (rev 56)
@@ -2,9 +2,9 @@
 An educational math tutorial game starring Tux, the Linux Penguin
 -----------------------------------------------------------------
 
-Oct 17, 2006
+Oct 31, 2006
 
-For tuxmath-0.98
+For tuxmath-1.0
 
 Objective
 ---------
@@ -35,12 +35,15 @@
 
   Windows
   -------
-    Just double-click the "tuxmath.exe" icon or select "Tuxmath" in the Start
+    Just double-click the "TuxMath.exe" icon or select "Tuxmath" in the Start
     Menu.  The current installer creates menu items to run tuxmath either in
     Fullscreen mode or within a 640 x 480 window.
     To be prompted for command line options, run tuxmath from the "Run" dialog
-    or the "C:> Command Prompt" console. Type "tuxmath.exe" followed by any 
-    desired options (see below). 
+    or the "C:> Command Prompt" console. Type "TuxMath.exe" followed by any 
+    desired options (see below). If it does not run, make sure the full path
+    to the program (e.g. C:\Program Files\TuxMath\TuxMath.exe) is known to 
+    Windows, either through Control Panel settings or by changing to the
+    directory containing TuxMath.exe before issuing the command.
 
   MacOS
   -----
@@ -189,7 +192,7 @@
       For example, "3 x 4 = ?" would be "12"
 
       Second, type in the answer.  As you type numbers on the keyboard, they
-      will appear in the "LED"-style display at the top center of the screen.
+      will appear in the "LED"-style display on Tux's flat-panel monitor.
       If negative answers are enabled, there will be a fourth place in the
       LED display for the minus sign.  The '-' and '+' keys will toggle the
       minus sign on and off, respectively.
@@ -219,7 +222,7 @@
   Using the On-Screen Keypad
   --------------------------
     If you launched the program with the "--keypad" (or "-k") option,
-    the game screen will also have an 11-key numeric keypad on the
+    the game screen will also have a numeric keypad on the
     center of the screen.  (It has a similar layout to most keyboard
     number pads and calculators.)
 
@@ -243,6 +246,8 @@
     The default mode is now to play through a defined list of questions. This
     mode is selected by setting the config file 'play_through_list' parameter
     to 1 ('yes' or 'true'), or via the "--playthroughlist" command line argument. 
+    The list is generated by TuxMath based on a series of selectable parameters
+    (selected math operations, number ranges, etc).
     By default, the questions are asked in a random order.  If answered
     correctly, they are removed.  A question that is not answered correctly
     (allowing the comet to destroy its target) will reappear in random
@@ -250,7 +255,8 @@
     have been destroyed, the player wins and a "victory" screen is displayed.
 
     The older arcade-style mode is also supported, in which the game continues
-    until you lose all of your cities.  A GAME OVER screen is displayed.
+    until you lose all of your cities.  A GAME OVER screen is then displayed.
+    Select this mode by setting 'play_through_list' to '0' ('no', 'false', 'off').
     By pressing any key or clicking the mouse, you return to the title
     screen.
 
@@ -281,6 +287,11 @@
   command-line options any more. In the near future, I plan to
   include a series of "lessons" that could be played in a planned order.
 
+  On a Windows XP or Windows 2000 system, the config file is called "options.txt"
+  and is located at C:\Documents And Settings\USER\Application Data\TuxMath\options.txt,
+  where USER is the login of the current user. Note that 'Application Data' is
+  hidden by default by the operating system.
+
   2. Many command-line options are supported (see above). 
 
   3. The "Options" screen allows several parameters to be set at run-time,
@@ -292,20 +303,18 @@
   many settings are only selectable via the config file.  This will be addressed
   in a later version of the program.
 
-  3. Editing the default values in tuxmath.h and mathcards.h and recompiling.
-  Now that the program reads and writes the settings from/to disc, this is of
-  interest only to developers.
+  4. The Windows build is packaged with a simple GUI-based config program that
+  can be used to set most of the options.
 
-
 Setting Administrative Options
 ------------------------------
   "Tux, of Math Command" allows parents/teachers to adjust which parts
   of the game options can be changed by the player.
 
   The game options are first read from a master config file in the program's
-  data directory (/usr/local/share/tuxmath/.tuxmath on *nix if installed 
-  using "make install"), then overridden by the user's own .tuxmath config
-  file if "per_user_config" is selected in the master .tuxmath config file.
+  data directory (/usr/local/share/tuxmath/options on *nix if installed 
+  using "make install"), then overridden by the user's own /.tuxmath/options
+  file if "per_user_config" is selected in the master options file.
   If "per_user_config" is deselected, the game starts up with the master
   settings.  (This is somewhat under construction).
 

Modified: tuxmath/trunk/docs/TODO.txt
===================================================================
--- tuxmath/trunk/docs/TODO.txt	2006-10-30 16:44:31 UTC (rev 55)
+++ tuxmath/trunk/docs/TODO.txt	2006-10-31 17:33:07 UTC (rev 56)
@@ -1,10 +1,10 @@
 TODO.txt for "tuxmath"
 
-September 20, 2006
+October 31, 2006
 
 Build:
-  * Fix certain file permissions issues when packaged as rpm.
-  * Consider using cmake.
+  * Refine NSIS installer for Windows (or perhaps executable
+    itself) to create Start Menu link to options.txt file
 
 Graphics:
   * Consider changing city graphics to something less violent.
@@ -39,7 +39,6 @@
   * Command-line options based on grade-level (?)
 
 Code:
-  * Error checking to make sure values from config files are sane.
   * Optimize graphics blitting!!!
   * Abstract SDL_BlitSurface() calls
 

Modified: tuxmath/trunk/docs/changelog
===================================================================
--- tuxmath/trunk/docs/changelog	2006-10-30 16:44:31 UTC (rev 55)
+++ tuxmath/trunk/docs/changelog	2006-10-31 17:33:07 UTC (rev 56)
@@ -1,5 +1,11 @@
 changelog for "tuxmath"
 
+2006.Oct.31 (https://svn.tux4kids.net/tuxmath/ - revision 54)
+  Version 1.0
+
+  Docs:
+    * Updated changelog, README.txt, INSTALL.txt, TODO.txt.
+
 2006.Oct.30 (https://svn.tux4kids.net/tuxmath/ - revision 53)
   Version 0.98
 

Modified: tuxmath/trunk/nsis/tuxmath.nsi
===================================================================
--- tuxmath/trunk/nsis/tuxmath.nsi	2006-10-30 16:44:31 UTC (rev 55)
+++ tuxmath/trunk/nsis/tuxmath.nsi	2006-10-31 17:33:07 UTC (rev 56)
@@ -2,7 +2,7 @@
 # with a few tiny modifications by Phil Harper(philh at theopencd.org)
 # modified for tuxmath by Yves Combe (yves at ycombe.net)
 
-!define PKG_VERSION "0.98"
+!define PKG_VERSION "1.0"
 !define PKG_PREFIX  "tuxmath"
 
 !define APP_PREFIX  "TuxMath"




More information about the Tux4kids-commits mailing list