team4alfanous team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 434
committer: Assem Chelli <assem.ch@xxxxxxxxx>
timestamp: Sun 2012-11-18 18:47:53 +0100
message:
  Update FAQ.rst
  
  Answer to "How to prepare your development environment to contribute?"
modified:
  FAQ.rst


--
lp:alfanous
https://code.launchpad.net/~team4alfanous/alfanous/alfanous-git

Your team Alfanous team is subscribed to branch lp:alfanous.
To unsubscribe from this branch go to https://code.launchpad.net/~team4alfanous/alfanous/alfanous-git/+edit-subscription

=== modified file 'FAQ.rst'
--- FAQ.rst	2012-10-20 10:34:28 +0000
+++ FAQ.rst	2012-11-18 17:47:53 +0000
@@ -209,6 +209,44 @@
 
 See also `How you can help?`_
 
+----------------------------------------------------------
+How to prepare your development environment to contribute?
+----------------------------------------------------------
+Best OS for that is Ubuntu (>11.10).
+
+#. First at all, create an account in `Github <https://github.com>`_ and make your own fork of `alfanous-team/alfanous <https://github.com/Alfanous-team/alfanous>`_ (Fork button is top-right).
+#. Secondly, install `git-scm <http://git-scm.com/downloads>`_ and then clone locally your fork : 
+      
+   .. code-block:: sh
+   
+       git clone LINK_OF_GITHUB_FORK.
+
+#. Third, install building dependecies :  `pyparsing <http://pyparsing.wikispaces.com/>`_, `pyqt4-dev-tools <http://www.riverbankcomputing.co.uk/software/pyqt/download>`_, `epydoc <http://epydoc.sourceforge.net/>`_,
+     `sphinx <http://sphinx.pocoo.org/>`_. 
+   - then run in the root of your local repo: 
+     
+     .. code-block:: sh
+    
+         $ make build 
+   - then run also in the same path: 
+     
+     .. code-block:: sh
+
+         $ sudo make install_api
+   - test the installation with this command: 
+     
+     .. code-block:: sh
+
+         $ alfanous-console -h
+
+#. Forth, prepare your dev tool :
+
+   - if you want work on web tasks, install `aptana <http://www.aptana.com/>`_ with `pydev <http://pydev.org/>`_ plugin (install apache2 also for local tests).
+   - else install `eclipse <http://www.eclipse.org/downloads/>`_ with `pydev <http://pydev.org/>`_ plugin.
+   - or you can just usea simple text editor.
+
+   You can also use git with eclipse, by installing `EGit <http://www.eclipse.org/egit/>`_.
+
 --------------
 How API works?
 --------------