From 7114a9e7496de9278c207cb97222e0e8bfa188d0 Mon Sep 17 00:00:00 2001 From: Jacob <124112219+jacobwojoski@users.noreply.github.com> Date: Sat, 28 Jun 2025 19:54:57 -0400 Subject: [PATCH] Feature/211 readme install updates (#212) * Update README.md * Update README.md * Update README.md --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9c58fece..5fecbd3e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ # Daggerheart +## Table of Contents +- [Overview](#overview) +- [User Install Guide](#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 +1. **(Not Yet Supported - No Releases Yet)** 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. **(Not Yet Supported - 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. **(Not Yet Supported - No Releases 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 +37,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.