Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorStijn Buys <ingar@osirion.org>2012-02-21 20:12:52 +0000
committerStijn Buys <ingar@osirion.org>2012-02-21 20:12:52 +0000
commitc38ac3b03a83096810003120039a934948a0eeb8 (patch)
treed5d3e73e9292424030e8b32e59279993ab794840 /README
parent4460f43972bd52c498161c64d4ddcc4da4c45d20 (diff)
Added documentation and license information.
Diffstat (limited to 'README')
-rw-r--r--README30
1 files changed, 28 insertions, 2 deletions
diff --git a/README b/README
index 5b703fe..9182d3b 100644
--- a/README
+++ b/README
@@ -1,5 +1,31 @@
-This is the Project::OSiRiON zone editor
-http://osirion.org
+Project::OSiRiON world editor - README
+ http://osirion.org
+ This is a quick-and-dirty editor for Project::OSiRiON zone ini files.
+ It's written in C++ and uses the Qt library.
+
+Usage
+
+ Use File -> Open to open an existing ini file.
+
+ You can drag the map using the right mouse button and zoom with the mouse wheel.
+
+ Use the left mouse button to select an entity on the map.
+
+ You can drag the selected entity around the map with the left mouse button.
+
+Source code
+
+ The latest version of the source code can be downloaded from the subversion repository
+ svn://osirion.org/osirion-editor
+
+License
+
+ The source code is licenced under the GENERAL PUBLIC LICENSE, version 2.
+ The full text of this licence can be found in the file named GPL.
+
+ Please refer to
+ http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ for more information about this license.