Commits

Thomas Atkinson committed 6698d03

Further changes to the Readme's in order to bring them up to the current configuration of autoREALM

  • Participants
  • Parent commits f94d2bf

Comments (0)

Files changed (2)

File Readme-CMake

     *"$make" (note: if you have a multi-core/thread processor, using "j x" where x is how many cores/threads you have +1 will speed up compilation process, if you
 			  have enough RAM. By example, if you have 2 cores with 2 threads, "-j 5" is a good idea.
     *"$make install"
+    
+    The executable can be found in /build/bin
+	The libraries can be found in /build/lib/
+	The plug-ins can be found in /build/lib/plugins
 
 RUNNING
 =======
 Installing configuration 
 ------------------------
 
-The executable can be found in autorealm/bin
-
-Currently, AutoREALM 3 is not able to generate itself it's configuration, and is not able to run without it, so you must install it yourself before run it. There
-are multiple ways to do this, the standard one and the xdg compliant version for Linux users. Also, it is split in 2 parts:
+CMake generates autoREALM 3's configuration and places it in /build/config.
 
     *copying the files 
     *adapting configuration for your use
-    
-EDIT: using CMake scripts AutoREALM 3 generates its configuration
-	  and puts it in /usr/local/etc/autorealm
-
-Copying files
-------------- 
-
-Windows
-
-Windows is less powerful here (but not because it is my choice: it's filesystems are just lacking possibilities): you can only copy (or move) the folder "autorealm/config/autorealm" in "%HOMEPATH%/.autorealm" be sure to rename the folder with a ".".
-
-Other OS 
-
-On POSIX operating systems, you have many solutions:
-
-    * classic configuration:: 
-
-        $ln autorealm/config/autorealm ~/.autorealm -s
-
-    * xdg configuration:: 
-
-        $ln autorealm/config/autorealm ~/.config/autorealm -s
-
-    * system-wide configuration:: 
-
-        $ln autorealm/config/autorealm /etc/autorealm -s
-
-WARNING: system-wide configuration, is NOT recommended, for some reasons:
-
-    * AutoREALM 3 is still in heavy development, and so it can break your system if installed widely
-    * system-wide configuration should only be made by package managers, to avoid wrong manipulations which can destroy your system
-    * you will need to manually move/link all files in correct destinations (/usr/bin and /usr/share) each time you change something in code.
-    * you will have to take care of right management 
-
-Adapting configuration to your system
--------------------------------------
 
-Edit the file autorealm/config/autorealm/config and replace occurrences with the right path. 
+Edit the file autorealm/config/autorealm/config and replace occurrences with the right path.
 ======
 
 AutoREALM is a drawing software mostly oriented to create RPG maps and dungeons, targeting people with no drawing or computer knowledge.
-This software was written for Windows, in delphi and was not maintained from many years, so the desiciion was made to rewrite it with more
+This software was written for Windows, in Delphi and was not maintained from many years, so the decision was made to rewrite it with more
 portable technologies, like C++, openGL and wxWidgets. Because autoREALM has had many attempts to rewrite it and because they all failed, resulting in
 undocumented, hard to read code, a real effort is made in this rewrite to keep a very clean base code and a clean architecture. To make 
-things easier to potential contributors, this rewrite also use a plug-in architecture. For more details about features of that soft, please go on the official
-website of the actual stable version: http://autorealm.sourceforge.net/ Please note that this rewrite is on alpha stage and under heavy development.
+things easier to potential contributors, this rewrite also uses a plug-in architecture. For more details about features of that soft, please go on the official
+website of the actual stable version: http://autorealm.sourceforge.net/.
+
+Please note that this rewrite is on alpha stage and under heavy development.
 
 Required Libraries
 ==================
 	* openGL (http://www.opengl.org/)
 	* wxWidgets (http://www.wxwidgets.org/)
-	* Puma (https://bitbucket.org/bmorel/pluma-fork)
+	* Pluma (https://bitbucket.org/bmorel/pluma-fork)
+	* tree template library (https://bitbucket.org/bmorel/tree
 
 Misc Requirements
 =================
 	* This project is built and developed using the Code::Blocks IDE
+	* autoRealm requires the tree template library to be copied into its /src directory