diff --git a/README.md b/README.md index 0f2e1a5b..866fa8ee 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,21 @@ This document is intended to get you up and running, but if don't care about wha ### What is this repository for? ### For the rapid development of the application for medium term deployment, the main branch is being used. -Once the application is deployed in a production environment, other branches should be used to properly stage edits and pushes of new features. +Once the application is deployed in a production environment, other branches should be used to properly stage edits and pushes of new features. When a significant feature is developed on a branch, raise a pull request and it can be reviewed before being put into production. Most of the documents here assume a basic knowledge of how Python and Django work (hint, if I don't say something, Google it, you will find 10000's of answers). The documentation is purely to be specific to TEC's application of the framework. ### Editing ### It is recommended that you use the PyCharm IDE by JetBrains. Whilst other editors are available, this is the best for integration with Django as it can automatically manage all the pesky admin commands that frequently need running, as well as nice integration with git. -Please contact TJP for details on how to acquire this. +For the more experienced developer/somebody who doesn't want a full IDE and wants it to open in less than the age of the universe, I can strongly recommend [Sublime Text](http://www.sublimetext.com/). It has a bit of a steaper learning curve, and won't manage anything Django/git related out of the box, but once you get the hang of it is by far the fastest and most powerful editor I have used (for any type of project). + +Please contact TJP for details on how to acquire these. ### Python Environment ### -Whilst it is not critical to the success of the application, it has be written with **Python 3** in mind. It might have been tested with Python 2, but it is not guaranteed to work with it. +Whilst the Python version used is not critical to the running of the application, using the same version usually helps avoid a lot of issues. Mainly the C implementation of Python 2 (CPython 2) has been used (specifically the Python 2.7 standard). Most of the application has been written with Python 3 in mind however, and should run without issue. Some level of testing on Python 3 has been done, but there is no guarantee it will work (for more information on this please see [[Python Version]] on the wiki) -Once you have Python 3 installed, please follow steps to set up a virtualenv, which will isolate the project from your system environment. +Once you have your Python distribution installed, go ahead an follow the steps to set up a virtualenv, which will isolate the project from the system environment. #### PyCharm #### If you are using the prefered PyCharm IDE, then this should be quite easy. @@ -43,11 +45,12 @@ To run the Django application follow these steps 5. Run the application #### Console Based #### -If you aren't using PyCharm, or want to use a console for some reason, this is really easy. Simply run +If you aren't using PyCharm, or want to use a console for some reason, this is really easy, there is even [virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/) to help things along. Simply run ``` virtualenv