German Larrain avatar German Larrain committed 3ff1a4f

install instructions and setup's software version updated

Comments (0)

Files changed (2)

-install
+To install the software (only "ars" is part of the installation; docs, tests and demos are not), you need to:
+
+1) check the requirements listed in README
+2) open a command window, with the current directoy set to the project main directory
+
+ANY OS:
+2) execute the standard setup script (included):
+	python setup.py install
+
+LINUX: If your OS is GNU/Linux and you have the "checkinstall" program installed, use it (it is optional but convenient)
+2) run the setup script wrapped by checkinstall, which will create a package and install it:
 	sudo checkinstall python setup.py install
-run
+
+	(if you want to uninstall, run
+	sudo dpkg -r ars)
+
+----------------------------------------
+
+To run a demo, execute any of the following:
 	python bin/FallingBall.py
-remove
-	dpkg -r ars
+	python python bin/IROS/example4_sinusoidal_terrain.py
 
+----------------------------------------
 
-documentation
-	epydoc generates API documentation for Python modules, based on their docstrings
+Documentation
+	the epydoc program generates API documentation for Python modules, based on their docstrings
 	
 	to build it, run the following command from the project main directory
 		epydoc -v --config doc/epydoc.cfg ars/
 	
-	to generate diagrams based on a python module, see "development notes.txt"
+	to generate class diagrams based on a python module, see "development notes.txt"
+
+----------------------------------------
 # coding: utf-8
 
-# Created on Nov 2, 2011
+# Created on 2011.11.02
 #
 # @author: german
 
 
 # only name, version, url are required. Other fields are optional.
 setup(name='Autonomous Robot Simulator',
-	version='20120309', #'0.0.0', # It is recommended that versions take the form major.minor[.patch[.sub]].
+	version='20120310', #'0.0.0', # It is recommended that versions take the form major.minor[.patch[.sub]].
 	description='A great simulator', # A single line of text, not more than 200 characters
 	long_description='', # Multiple lines of plain text in reStructuredText format
 	author='German Larrain',
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.