Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
OpenNingia committed Apr 29, 2019
1 parent 9a64ee4 commit 0788fd0
Showing 1 changed file with 17 additions and 25 deletions.
42 changes: 17 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,56 +9,48 @@
```bash
git clone https://github.com/OpenNingia/l5r-character-manager-3.git
cd ./l5r-character-manager-3/
git submodule init
git submodule update
git checkout develop
```

### Installing the dependencies
Before running the program you need to install the dependencies:
Some of them can be installed using pip:
### Create a virtual environment
Install python3-venv and create a new virtual environment for python.

```bash
pip install -U asq
pip install -U lxml
apt install python3-venv
python3 -m venv .venv
source .venv/bin/activate
```

Then you need to install PyQt4. On a Debian system run:
### Installing the dependencies
Before running the program you need to install the dependencies:
Some of them can be installed using pip:

```bash
apt-get install python-sip python-qt4
pip install -r requirements.txt
pip install git+https://github.com/OpenNingia/l5rcm-data-access.git@develop
```

Windows users can download PyQt4 binaries from here:
Windows users can download PyQt5 binaries from here:
https://www.riverbankcomputing.com/software/pyqt/download

### Note for Windows users
You will need a basic compiler in order to build some of the dependencies (mainly lxml). I recommend getting this one:

http://www.microsoft.com/en-us/download/details.aspx?id=44266
You will need a basic compiler in order to build some of the dependencies (mainly lxml).

You will also need to install Python 2.7.x from here:
You will also need to install Python 3.6.x from here:

https://www.python.org/downloads/

### Note for Linux users
You will need to download one more dependency, the pdf toolkit, needed to export the character sheets.
Use you package manager to install the `pdftk` package. On debian systems run:

`apt-get install pdftk` or `aptitude install pdftk`

### Note for MacOSX users
I don't actually own a Mac, so I cannot test it, however these instruction should work also on OSX.
You might need to manually download the pdf toolkit from here:

https://www.pdflabs.com/tools/pdftk-server/
Use you package manager to install the `pdftk` package. I recommend this version:

then place the executable in the system path.
https://gitlab.com/pdftk-java/pdftk

### Finally you launch the program

```
cd l5r
python main.py
python3 main.py
```

## Getting the Datapacks
Expand Down

0 comments on commit 0788fd0

Please sign in to comment.