cosmo/daggerheart
1
0
Fork 0
mirror of https://github.com/Foundryborne/daggerheart.git synced 2026-01-16 23:26:28 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Jacob 2025-06-28 19:20:53 -04:00 • committed by GitHub
parent 0a5f9c8905
commit 04b3635e91
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,9 +1,20 @@
# Daggerheart # 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 <path>/<to>/<repo>` - Open a terminal in the directory with the repo `cd <path>/<to>/<repo>`
- 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: 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 <path to development folder> daggerheart` inside the system folder - NOTE: Linux link can be made using `ln -snf <path to development folder> daggerheart` inside the system folder
@ -27,4 +38,4 @@ Now you should be able to build the app using `npm start`
## Contributing ## 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. 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.