Commits

Morel Bérenger committed 67acaa7 Merge

Merged in cptnbrittish/autorealm (pull request #2)

Readme Documentation Rewrite

Comments (0)

Files changed (2)

-cmake 
+CMAKE README
+============
 
-go into autorealm/build (create the folder if it does not exists) and then enter those commands:
+BUILDING autoREALM
+==================
 
-    *"$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"
-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 that, the standard one and the xdg compliant version for linux users. Also, it is split in 2 parts:
-
-EDIT: using CMake scripts AutoREALM 3 generates its configuration
- and puts it in /usr/local/etc/autorealm
-
-    *copying the files *adapting configuration for your use
-
-Copying files 
-Windows 
-
-Again, 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 
+Go into autorealm/build (create the folder if it does not exists) and then enter these commands:
 
-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:: 
+    *"$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
 
-        $ln autorealm/config/autorealm /etc/autorealm -s
+RUNNING
+=======
 
-WARNING: system-wide configuration, is NOT recommended, for some reasons:
+Installing configuration 
+------------------------
 
-    * 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 
+CMake generates autoREALM 3's configuration and places it in /build/config.
 
-Adapting configuration to your system 
+    *copying the files 
+    *adapting configuration for your use
 
-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.
+README
+======
+
+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 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 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/)
+	* 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
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.