mirror of
https://github.com/Foundryborne/daggerheart.git
synced 2026-01-12 03:31:07 +01:00
Feature/211 readme install updates (#212)
* Update README.md * Update README.md * Update README.md
This commit is contained in:
parent
0a5f9c8905
commit
7114a9e749
1 changed files with 13 additions and 3 deletions
14
README.md
14
README.md
|
|
@ -1,9 +1,19 @@
|
||||||
# Daggerheart
|
# 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 <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
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue