Commits

Benoît Bryon committed 8f015e8

Introduced quickstart guide for developers in docs: uses buildout

  • Participants
  • Parent commits 23ca258
  • Branches namespace-and-buildout

Comments (0)

Files changed (2)

File docs/contribute.txt

+#######################
+Contribution quickstart
+#######################
+
+********************************************
+As always, configure an isolated environment
+********************************************
+
+This part is more an advice than a part of the procedure: you may already 
+have a Python environment. As many others, I recommend using an isolated one.
+Virtualenv is a really useful for this.
+
+Here are some commands to create an isolated Python environment. You must 
+install Python and virtualenv first. You may install distribute too.
+
+.. code-block:: bash
+
+  mkdir test-formrenderingtools
+  cd test-formrenderingtools
+  virtualenv --no-site-packages dev
+  source dev/bin/activate
+
+**************************************************************************
+Install django-formrenderingtools and initialize a development environment
+**************************************************************************
+
+.. code-block:: bash
+
+  hg clone http://bitbucket.org/benoitbryon/django-formrenderingtools -r namespace-and-buildout
+  cd django-formrenderingtools
+  python bootstrap.py -d
+  bin/buildout
+  bin/test
+
+If everything went fine, you have a buildout environment and can test the 
+application.
+
+**********
+Contribute
+**********
+
+* Create issues if necessary
+* Create a branch per issue. See https://bitbucket.org/benoitbryon/django-formrenderingtools/issues/
+* Make your changes
+* test with bin/test
+* commit and push

File docs/index.txt

    tutorial
    reference/index
    examples/index
+   contribute
    LICENSE
    AUTHORS
    CHANGES