Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

commit b241089fc25c6434be35d70586d73b7cbbf88a24
parent e4d68c3b44e197c48a23a68446ed585f8eebc252
Author: Skylar Hill <stellarskylark@posteo.net>
Date:   Sun,  5 Jun 2022 04:00:25 -0500

Add installation instructions

MREADME.md | 9+++++++++
1 file changed, 9 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md @@ -20,6 +20,15 @@ ## Planned related projects * `dndsheet` -- `rpgsheet` but with a streamlined dnd5e-specific interface which, given a sheet following a particular standard, can provide an experience tailored to the system. +## Installation +Once I'm in the nimble directory, you'll be able to fetch it pretty easily by installing Nim and running: + +`nimble install rpgsheet` + +You can also clone this repo and then run this in the directory: + +`nimble install` + # The sheet format Sheets are stored as YAML files. Keys are limited to alphanumeric characters, plus `_`, `~`, and `'`. When displayed "nicely" in the interface, `_` is converted to a space, and `~` to a hyphen.