Developer installation

If you are looking to develop for sc2reader, these are the best ways to get started:

Linux

Open up a terminal and preform these actions (Note: We assume you have installed python 2.7)

1. Clone the repository: git clone git@github.com:GraylinKim/sc2reader.git

Note: You should probably fork the repository first if you want to commit to github. If you do replace the git address with your repository's ssh address.

2. Install pip: sudo apt-get install python-pip

3. run this line: sudo python SC2READER_PATH/setup.py develop

Note: sudo is only necessary for python packages that are installed the /usr/bin/python directory. If you have a custom installation of python or a package manager that does use the standard directory, remember to refer their package management documentation (if you have no idea what I'm talking abut you can ignore this message).

Now if you run python and type import sc2reader the package should load from your working tree. In order for changes you make in your working copy to effect the operation of the imported package python will need to be reloaded(i.e exit() python and open it again and call import sc2reader.