Updated the user notes.

master v0.1
Pacman Ghost 7 years ago
parent 17e34aa583
commit 323d48d049
  1. 7
      README.md

@ -17,6 +17,7 @@ If you want to compile it:
```
python3 _freeze.py --output /tmp/aslcards.tar.gz
```
Pre-built versions are provided for Windows, since setting up a build environment is a messy affair. On Linux, it's straight-forward to run from source, or compile a binary. Things should work on a Mac, but I don't have one, so can't test this.
### Analyzing the PDF files
<img src="doc/analyze-files.png" width="300" align="left" hspace="10">The first time you run the program, it needs to analyze the PDF files, to extract each data card (this only needs to be done once).
@ -35,14 +36,14 @@ You need to have [Ghostscript](https://ghostscript.com/download/gsdnld.html) ins
<a name="faq"></a>
## FAQ
#### I'm getting errors about the number of cards and images not being the same
#### I'm getting errors about the number of cards and images not being the same.
The program needs to know basic details about each card e.g. the name of the AFV/Gun, it's nationality. There is code to extract this text, but unfortunately, due to the way the PDF's have been constructed, it comes out garbled. To work around this, the cards have been indexed manually, and were correct at this time of writing, but if your PDF's are different to mine, you may get this error. In the <tt>index/</tt> sub-directory, there are files that list the cards contained in each PDF - edit them to match the contents of your PDF's, and things should work.
#### Windows is complaining about a missing DLL
#### Windows is complaining about a missing DLL.
You need the [VS 2015 Runtime](https://www.microsoft.com/en-us/download/details.aspx?id=48145) installed.
#### Can I change the keyboard shortcuts used to flip between cards?
Keyboard shortcuts can be used to flip between the cards of commonly-used nationalities e.g. ^G for the Germans, ^R for the Russians. These are defined in <tt>$/asl_cards/natinfo/natinfo.json</tt>, and you can change other nationality-based settings here as well.
#### Can I run this on 32-bit Linux?
Possibly, but setting up the requirements is tricky. PyQt5, in particular, only offer 64-bit versions for Linux and OS X.
Probably, but setting up the requirements is tricky. PyQt5, in particular, only offers 64-bit versions for Linux and OS X at the Cheese Shop.

Loading…
Cancel
Save