From d27c68e4eecf5d76ff2f07eb284983fc12189d84 Mon Sep 17 00:00:00 2001 From: zakx Date: Mon, 10 Apr 2017 22:57:13 +0200 Subject: [PATCH] Updating README to reflect new tooling --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b8b975b804..18c67aebbf 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,22 @@ Open Source Inventory Management System [![Build Status](https://travis-ci.org/inventree/InvenTree.svg?branch=master)](https://travis-ci.org/inventree/InvenTree) ## Installation -When first installing InvenTree, initial database configuration must be performed. This is handled by the `install.py` script, which performs the following actions: +It is recommended to set up a clean Python 3.4+ virtual environment first: +`mkdir ~/.env && python3 -m venv ~/.env/InvenTree && source ~/.env/InvenTree/bin/activate` -1. Installs required django packages (requires [pip](https://pypi.python.org/pypi/pip)) +You can then continue running `make setup` (which will be replaced by a proper setup.py soon). This will do the following: + +1. Installs required Python dependencies (requires [pip](https://pypi.python.org/pypi/pip), should be part of your virtual environment by default) 1. Performs initial database setup 1. Updates database tables for all InvenTree components -This script can also be used to update the installation if changes have been made to the database configuration. +This command can also be used to update the installation if changes have been made to the database configuration. -To create an initial user account, run the command `python InvenTree/manage.py createsuperuser` +To create an initial user account, run the command `make superuser`. ## Documentation For project code documentation, refer to the online [documentation](http://inventree.readthedocs.io/en/latest/) (auto-generated) ## Coding Style -All python code should conform to the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide. Run the *pep_check.py* script which will compare all source (.py) files against the PEP 8 style. +If you'd like to contribute, install our development dependencies using `make develop`. +All Python code should conform to the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide. Run `make style` which will compare all source (.py) files against the PEP 8 style. Tests can be run using `make test`.