search

kinkofer / FightClub5eXML

Creating XML files of all D&D sources compatible with Fight Club 5e and Game Master 5e apps for iOS and Android.
MIT License
706 stars 395 forks source link

Update root-level README and reorganize sources #178

Closed zcdziura closed 2 years ago

zcdziura commented 3 years ago

In an effort to mitigate questions from new, inexperienced users on how to import data into Fight Club 5e, I rewrote and reorganized the root-level README file to include detailed instructions on how to compile their own compendiums using the sources found within this repository. Some existing data, such as how to create your own collection file, was moved into other READMEs under the Collections and Sources directories.

I also took some liberty in reorganizing the directory structure of this repository and renamed some of the top-level directories. In my view, having sources under the "FightClub5eXML" folder didn't make a lot of sense, so I moved those sources into the top-level "Sources" folder. I made sure to update all of the collection files, along with the "travis.yml" config file, to properly point to the correct folders.

Finally, while updating the "travis.yml" config file, I changed the output folder of those build compendiums to be under a top-level "Compendiums" folder. This folder is ignored by git.

zcdziura commented 2 years ago

@kinkofer Will you take a look at this PR and merge if you think that things look OK?