chore: Update README and CHANGELOG
Chris Jennewein
parent
8cafe8edf8
commit
3c0124db37
|
|
@ -1,6 +1,6 @@
|
|||
## CHANGE LOG
|
||||
|
||||
### 2021-11-02
|
||||
### 2022-11-14
|
||||
|
||||
Update the root-level README to provide clear instructions on how to use this repository to import data into Fight Club 5e.
|
||||
|
||||
|
|
@ -8,6 +8,8 @@ Reorganize the READMEs across the repo to better reflect the purpose of their co
|
|||
|
||||
Rename the FightClub5eXML folder to Sources to better reflect its given purpose.
|
||||
|
||||
Add build-collections.bat for Windows users.
|
||||
|
||||
### 2021-08-04
|
||||
|
||||
Removed deployment to Dropbox.
|
||||
|
|
|
|||
14
README.md
14
README.md
|
|
@ -14,7 +14,7 @@ This repository contains several collection files which can be found within the
|
|||
|
||||
Click on the green "Code" button towards the top of the page, and then click on the "Download ZIP" button on the subsequent modal popup. Extract the ZIP archive to your `Documents` folder. On Windows, this will be `C:\Users\YOUR_USER_NAME\Documents`; on macOS, this will be `/Users/YOUR_USER_NAME/Documents`.
|
||||
|
||||
The location on your computer that you extract this repository to will be referred to as the **repository root** folder. The path to the repository root should be something like `C:\Users\YOUR_USER_NAME\Documents\FightClub5eXML-master` or `/Users/YOUR_USER_NAME/Documents/FightClub5eXML-master`.
|
||||
The location on your computer that you extract this repository to will be referred to as the **repository root** folder. The path to the repository root should be something like `C:\Users\YOUR_USER_NAME\Documents\FightClub5eXML-main` or `/Users/YOUR_USER_NAME/Documents/FightClub5eXML-main`.
|
||||
|
||||
### Install `xsltproc`
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ You should be able to use your distro's official package manager to install eith
|
|||
|
||||
### Compile a Collection Into a Compendium
|
||||
|
||||
Open a command-line terminal (such as PowerShell on Windows or Terminal on macOS) and navigate to the repository root. You can do so by executing `cd C:\Users\YOUR_USER_NAME\Documents\FightClub5eXML-master` on Windows, or `cd /Users/YOUR_USER_NAME/Documents/FightClub5eXML-master` on macOS.
|
||||
Open a command-line terminal (such as PowerShell on Windows or Terminal on macOS) and navigate to the repository root. You can do so by executing `cd C:\Users\YOUR_USER_NAME\Documents\FightClub5eXML-main` on Windows, or `cd /Users/YOUR_USER_NAME/Documents/FightClub5eXML-main` on macOS.
|
||||
|
||||
Next, execute the `xsltproc` program to compile a collection file into a compendium file. For example, if you wanted to compile the `CoreOnly.xml` collection, you would execute the following command:
|
||||
|
||||
|
|
@ -46,6 +46,14 @@ xsltproc -o Compendiums/CoreOnly.xml Utilities/merge.xslt Collections/CoreOnly.x
|
|||
|
||||
After that command has completed, you should see a file called `Compendium.xml` in the newly created `Compendiums` folder. You can then download that file onto your smartphone and import it into Fight Club 5e.
|
||||
|
||||
#### Batching
|
||||
|
||||
The build-collection files are provided for your convenience to compile all collections within your Collections directory into compendiums.
|
||||
|
||||
## Custom Content
|
||||
|
||||
See the [Sources README](Sources/README.md) to learn how to add your own homebrew content or build your own compendium from select source material.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute, feel free to fork the repository and submit pull requests with your changes. We are no longer accepting manual changes to the XML source files because these files are now generated from an external source.
|
||||
|
|
@ -63,3 +71,5 @@ If you'd like to contribute, feel free to fork the repository and submit pull re
|
|||
`@fightclub5exml` and `@dragonahcas` for carrying the mantle.
|
||||
|
||||
`@zcdziura` for answering user's questions.
|
||||
|
||||
`@sheppe` for the Widows bat file.
|
||||
|
|
|
|||
|
|
@ -76,21 +76,21 @@ You can find an online XML Linter or use xmllint in the command line. The schema
|
|||
Here is an example, running xmllint at the top level of the repo, using the compendium schema to validate an xml file in Sources:
|
||||
|
||||
```bash
|
||||
xmllint --noout --schema Utilities/compendium.xsd FightClub5eXML/Sources/CoreRulebooks.xml
|
||||
xmllint --noout --schema Utilities/compendium.xsd Sources/CoreRulebooks.xml
|
||||
```
|
||||
|
||||
## Build Your Own Compendium
|
||||
|
||||
### Create a collection file
|
||||
|
||||
A collection file is an XML file that lists which sources you would like to merge into your custom Compendium. It must follow this format:
|
||||
A collection file is an XML file that lists which sources you would like to merge into your custom Compendium. It must follow this format (assuming you create your file within the `Collections` directory):
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<collection>
|
||||
<doc href="../FightClub5eXML/Sources/PlayersHandbook.xml" />
|
||||
<doc href="../FightClub5eXML/Sources/DungeonMastersGuide.xml" />
|
||||
<doc href="../FightClub5eXML/Sources/MonsterManual.xml" />
|
||||
<doc href="../Sources/PlayersHandbook.xml" />
|
||||
<doc href="../Sources/DungeonMastersGuide.xml" />
|
||||
<doc href="../Sources/MonsterManual.xml" />
|
||||
</collection>
|
||||
```
|
||||
You can have one or more `<doc>` tags. Each doc must reference an xml file with a `<compendium>` root element.
|
||||
|
|
@ -101,8 +101,4 @@ The name of the collection file will be the name of the final Compendium.
|
|||
|
||||
With your collection in place, you're ready to build your Compendium by merging the sources together.
|
||||
|
||||
Execute this line in your shell at the top level of the repo:
|
||||
|
||||
```bash
|
||||
for i in Collections/*.xml; do xsltproc -o $i Utilities/merge.xslt $i; done
|
||||
```
|
||||
See the instructions to `Compile a Collection Into a Compendium` in the root-level [README](/README.md).
|
||||
|
|
|
|||
Loading…
Reference in New Issue