diff --git a/README.md b/README.md index d68ba75..45c950b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ -# asl_cards -A UI to view cards in the "ASL Cards" PDF's. +# ASL Cards + +If you're a fan of [ASL](https://en.wikipedia.org/wiki/Advanced_Squad_Leader), then Chris Edward's [ASL Cards](http://aslcards.com) are a useful play tool. He provides PDF's with data cards for every AFV and Gun in the system, which are handy to reference as you play a scenario. + +However, unless you print them out, it's difficult to quickly switch between the ones you want, so I wrote this program that lets you pick out the ones you want, with a tabbed viewer that lets you quickly flip between them. + +### Analyzing the PDF files +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). + +Simply point to the directory where the files live, and click Analyze. This process can take some time to run, ~5-10 minutes at the lowest resolution, ~1 hour at the highest. + +### Selecting cards +Once the files have been analyzed, you can pick out the cards you want. +
+The cards are now easily accessible as you play the scenario. diff --git a/doc/add-card.png b/doc/add-card.png new file mode 100644 index 0000000..22306b6 Binary files /dev/null and b/doc/add-card.png differ diff --git a/doc/analyze-files.png b/doc/analyze-files.png new file mode 100644 index 0000000..6c24041 Binary files /dev/null and b/doc/analyze-files.png differ diff --git a/doc/open-database.png b/doc/open-database.png new file mode 100644 index 0000000..8e83ec5 Binary files /dev/null and b/doc/open-database.png differ diff --git a/doc/view-cards.png b/doc/view-cards.png new file mode 100644 index 0000000..f77e396 Binary files /dev/null and b/doc/view-cards.png differ