From 04b3635e9189c655c03e10d4eb966014917010e5 Mon Sep 17 00:00:00 2001 From: Jacob <124112219+jacobwojoski@users.noreply.github.com> Date: Sat, 28 Jun 2025 19:20:53 -0400 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9c58fece..7a3eb07d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ # Daggerheart +## Table of Contents +- [Overview](#overview) +- [User Setup](#user-install) +- [Developer Setup](#developer-setup) +- [Contribution Info](#contributing) -This is a repo for a Foundry VTT implementation of daggerheart. It is not associated with Critical Role or Darrington Press. +## Overivew +This is a community repo for a Foundry VTT implementation of Daggerheart. It is not associated with Critical Role or Darrington Press. -## Setup +## User Install +### Download Through system.json +1. Pasting `https://raw.githubusercontent.com/Foundryborne/daggerheart/refs/heads/main/system.json` into the Install System dialog on the Setup menu of the application. +2. (No Releases Yet) Browsing the repository's Releases page, where you can copy any system.json link for use in the Install System dialog. +3. (No Archives Yet) Downloading one of the .zip archives from the Releases page and extracting it into your foundry Data folder, under Data/systems/daggerheart. +## Development Setup - Open a terminal in the directory with the repo `cd //` - NOTE: The repo should be placed in the system files are or somewhere else and a link (if on linux) is placed in the system directory - NOTE: Linux link can be made using `ln -snf daggerheart` inside the system folder @@ -27,4 +38,4 @@ Now you should be able to build the app using `npm start` ## Contributing -Looking to contribute to the project? Look no further, check out our [contributing guide](contributing.md), and keep the [Code of Conduct](coc.md) in mind when working on things. \ No newline at end of file +Looking to contribute to the project? Look no further, check out our [contributing guide](contributing.md), and keep the [Code of Conduct](coc.md) in mind when working on things.