diff --git a/README.md b/README.md index 6a9fe8e..e4d3233 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ This program lets you search through the ASL Rulebook index, and jump directly to the rules you're looking for. -Click [here](doc/features/) for more details. +Click [here](https://htmlpreview.github.io/?https://github.com/pacman-ghost/asl-rulebook2/blob/master/doc/features/index.html) for more details.
With [some work](doc/extend.md), you can also: diff --git a/doc/features/images/download.png b/doc/features/images/download.png new file mode 100644 index 0000000..d744b59 Binary files /dev/null and b/doc/features/images/download.png differ diff --git a/doc/features/index.html b/doc/features/index.html index 54be82c..afee304 100644 --- a/doc/features/index.html +++ b/doc/features/index.html @@ -1,12 +1,9 @@ - - ASL Rulebook 2 features + ASL Rulebook 2 @@ -14,7 +11,9 @@

-

Basic features

+

ASL Rulebook 2 + +

Out-of-the-box, this program gives you full-text search over the ASLRB index.

It will jump to the exact position in the eASLRB PDF for a rule when you click on a search result.

And if the rule has any associated footnotes, these will be shown in a popup. @@ -26,7 +25,7 @@

-

Adding rules for other modules

+

Adding rules for other modules

Once you've got the program up and running, you can then think about extending it. It's a lot of work, but the results are insanely cool!

To the right, I've searched for "cellar", and the program has found results from Red Barricades. The rules for this are referenced in the ASLRB index, but the content is not yet in the MMP eASLRB.

However, I've installed a PDF scan of the rules, plus information about where each rule is within that PDF (a "targets file"), and so when I click on a search result, it seamlessly opens the Red Barricades PDF and jumps to that rule. @@ -43,7 +42,7 @@ You can also include third-party modules that are not referenced in the ASLRB in

-

Showing Q+A and errata

+

Showing Q+A and errata

Q+A and errata can also be included. This is a lot of work, but the results are amazing. If you click on a rule that has Q+A and/or errata associated with it, they will be shown, alongside the rule you're looking for.

Here, I've searched for "encircled", and the program has automatically shown Q+A and errata for rule A7.7.

Note that this errata is actually obsolete, since it's already been incorporated into the current MMP eASLRB, but it's shown here as an example.
@@ -56,14 +55,14 @@ Going back to the search results, you can see these Q+A entries included in ther

-

User annotations

+

User annotations

You can also add your own notes to the search engine.

Here, I've added a note about what Majority Squad Type means, and a link back to the Game Squad post that talks about it.

-

Advanced Sequence Of Play

+

Advanced Sequence Of Play

Finally, the ASOP can also be included, with clickable links to each of the referenced rules.

ASOP entries are also included in search results: