Merge pull request #96 from tzumainn/docs
created INSTALL.rst, added Contacts, fixed links
This commit is contained in:
mtaylor
commit
e91b2e75c7
@ -33,8 +33,9 @@ Getting Started
|
||||
Setting up the Tuskar development environment
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This assumes you have done all the basic setup as described in the
|
||||
README. Run the following::
|
||||
This assumes you have done all the basic setup as described in
|
||||
`INSTALL.rst <https://github.com/tuskar/tuskar/blob/master/INSTALL.rst>`_.
|
||||
Run the following::
|
||||
|
||||
# creates symlinks for installed code. Used for dev environment.
|
||||
$ python setup.py develop
|
||||
|
||||
47
INSTALL.rst
Normal file
47
INSTALL.rst
Normal file
@ -0,0 +1,47 @@
|
||||
==================
|
||||
Installation Guide
|
||||
==================
|
||||
|
||||
Tuskar source code should be pulled directly from git::
|
||||
|
||||
git clone https://github.com/tuskar/tuskar.git
|
||||
|
||||
Setting up a local environment for development can be done with tox::
|
||||
|
||||
cd <your_src_dir>/tuskar
|
||||
|
||||
# install prerequisites
|
||||
* Ubuntu/Debian:
|
||||
sudo apt-get install python-dev swig libssl-dev python-pip libmysqlclient-dev libxml2-dev libxslt-dev
|
||||
* Fedora/RHEL:
|
||||
sudo yum install python-devel swig openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel
|
||||
# Note that as of Fedora 19, you need to use the community
|
||||
upstream for mysql, called mariadb-devel
|
||||
|
||||
sudo easy_install nose
|
||||
sudo pip install virtualenv setuptools-git flake8 tox
|
||||
# With the exception of flake8, all of the above are also
|
||||
available for fedora via yum
|
||||
|
||||
# create virtualenv
|
||||
tox -evenv -- echo 'done'
|
||||
|
||||
# activate the virtualenv
|
||||
source .tox/venv/bin/activate
|
||||
|
||||
# run testr init
|
||||
testr init
|
||||
|
||||
# run pep8/flake8 checks
|
||||
flake8
|
||||
|
||||
# run unit tests
|
||||
testr run
|
||||
|
||||
# deactivate the virtualenv
|
||||
deactivate
|
||||
|
||||
For additional developer information, take a look at
|
||||
`CONTRIBUTING.rst <https://github.com/tuskar/tuskar/blob/master/CONTRIBUTING.rst>`_
|
||||
and the
|
||||
`Tuskar website <https://github.com/tuskar/tuskar/blob/master/docs/index.rst>`_.
|
||||
68
README.rst
68
README.rst
@ -23,56 +23,24 @@ decisions.
|
||||
For additional information, take a look at the `Tuskar
|
||||
documentation <https://github.com/tuskar/tuskar/blob/master/docs/index.rst>`_.
|
||||
|
||||
Developer Information
|
||||
---------------------
|
||||
|
||||
Tuskar source code should be pulled directly from git::
|
||||
|
||||
git clone https://github.com/tuskar/tuskar.git
|
||||
|
||||
Setting up a local environment for development can be done with tox::
|
||||
|
||||
cd <your_src_dir>/tuskar
|
||||
|
||||
# install prerequisites
|
||||
* Ubuntu/Debian:
|
||||
sudo apt-get install python-dev swig libssl-dev python-pip libmysqlclient-dev libxml2-dev libxslt-dev
|
||||
* Fedora/RHEL:
|
||||
sudo yum install python-devel swig openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel
|
||||
# Note that as of Fedora 19, you need to use the community
|
||||
upstream for mysql, called mariadb-devel
|
||||
|
||||
sudo easy_install nose
|
||||
sudo pip install virtualenv setuptools-git flake8 tox
|
||||
# With the exception of flake8, all of the above are also
|
||||
available for fedora via yum
|
||||
|
||||
# create virtualenv
|
||||
tox -evenv -- echo 'done'
|
||||
|
||||
# activate the virtualenv
|
||||
source .tox/venv/bin/activate
|
||||
|
||||
# run testr init
|
||||
testr init
|
||||
|
||||
# run pep8/flake8 checks
|
||||
flake8
|
||||
|
||||
# run unit tests
|
||||
testr run
|
||||
|
||||
# deactivate the virtualenv
|
||||
deactivate
|
||||
|
||||
For additional developer information, take a look at the `Tuskar
|
||||
website <https://github.com/tuskar/tuskar/blob/master/docs/index.md>`_.
|
||||
|
||||
Contributing
|
||||
~~~~~~~~~~~~
|
||||
Installation Information
|
||||
------------------------
|
||||
|
||||
Please see
|
||||
`CONTRIBUTING.md <https://github.com/tuskar/tuskar/blob/master/CONTRIBUTING.md>`_
|
||||
for details on how to contribute.
|
||||
`INSTALL.rst <https://github.com/tuskar/tuskar/blob/master/INSTALL.rst>`_
|
||||
for an installation guide.
|
||||
|
||||
Send pull requests!
|
||||
Contributing
|
||||
------------
|
||||
|
||||
Interested in contributing? Take a look at
|
||||
`CONTRIBUTING.rst <https://github.com/tuskar/tuskar/blob/master/CONTRIBUTING.rst>`_
|
||||
for details on how to do so.
|
||||
|
||||
Contact Us
|
||||
----------
|
||||
|
||||
Join us on IRC (Internet Relay Chat)::
|
||||
|
||||
Network: Freenode (irc.freenode.net/tuskar)
|
||||
Channel: #tuskar
|
||||
|
||||
@ -46,9 +46,9 @@ Install and Contribute
|
||||
----------------------
|
||||
|
||||
- `Install
|
||||
Guide <https://github.com/tuskar/tuskar/blob/master/README.md>`_
|
||||
Guide <https://github.com/tuskar/tuskar/blob/master/INSTALL.rst>`_
|
||||
- `Contributing
|
||||
Guide <https://github.com/tuskar/tuskar/blob/master/CONTRIBUTING.md>`_
|
||||
Guide <https://github.com/tuskar/tuskar/blob/master/CONTRIBUTING.rst>`_
|
||||
- `Debugging with
|
||||
iPython <https://github.com/tuskar/tuskar/wiki/Debugging-with-iPython>`_
|
||||
- `Demo Data
|
||||
@ -77,3 +77,12 @@ Other
|
||||
-----
|
||||
|
||||
- *TODO* link to developer portion of FAQ
|
||||
|
||||
Contact Us
|
||||
==========
|
||||
|
||||
Join us on IRC (Internet Relay Chat)::
|
||||
|
||||
Network: Freenode (irc.freenode.net/tuskar)
|
||||
Channel: #tuskar
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user