From 26e0ab5c84959628aed0e8c41f949dce81408345 Mon Sep 17 00:00:00 2001 From: CK <31608392+unrealkakeman89@users.noreply.github.com> Date: Tue, 1 Sep 2020 11:18:55 -0400 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 936a4572..1cbea601 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ -# sw5e -SW5E Foundry VTT System +# Foundry Virtual Tabletop - SW5e Game System -For easy install +This game system for [Foundry Virtual Tabletop](http://foundryvtt.com) provides character sheet and game system +support for the SW5E roleplaying game. -In the Foundry Configuration and Setup window go to the Game Systems tab, click on the "Install System" button, and -place the following link into the Manifest URL at the bottom +This system provides character sheet support for Actors and Items, mechanical support for dice and rules necessary to +play games of 5th Edition, and compendium content for Monsters, Heroes, Items, Powers, Class Features, Monster +Features, and more! + +The software component of this system is distributed under the GNUv3 license. + +## Installation Instructions + +To install and use the SW5e system for Foundry Virtual Tabletop, simply paste the following URL into the +**Install System** dialog on the Setup menu of the application. https://raw.githubusercontent.com/unrealkakeman89/sw5e/master/system.json + +If you wish to manually install the system, you must clone or extract it into the ``Data/systems/sw5e`` folder. You +may do this by cloning the repository or downloading a zip archive from the +[Releases Page](https://github.com/unrealkakeman89/sw5e). + +## Community Contribution + +Code and content contributions are accepted. Please feel free to submit issues to the issue tracker or submit merge +requests for code changes. Approval for such requests involves code and (if necessary) design review by The Dev Team. +Please reach out on the SW5E Foundry Dev Discord with any questions.