From 96f73b110e59ec74e066770df6b37ebaac23123c Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Sat, 5 Jan 2019 13:03:46 +0000 Subject: improve README Signed-off-by: Sean Whitton --- NEWS.md | 1 + README.md | 28 +++++++++++++++++++++++++--- TODO.md | 1 - 3 files changed, 26 insertions(+), 4 deletions(-) diff --git a/NEWS.md b/NEWS.md index 6d0af18..433f041 100644 --- a/NEWS.md +++ b/NEWS.md @@ -3,6 +3,7 @@ - New defcustom, `org-d20-letter-monsters` - New defcustom, `org-d20-continue-monster-numbering` +- Improve README for new users 0.2 (2018-12-31) ---------------- diff --git a/README.md b/README.md index 0f7791a..e733646 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,13 @@ are visiting that buffer. For example, description of the monsters and the terrain. The minor mode's defaults suit the way that I run D&D 5e. Patches to -add `defcustoms` to make org-d20 more suitable for other games and -other sets of house rules are welcome. +add `defcustoms` to make org-d20 more suitable for other games, and +other sets of house rules, are welcome. + +## Installation ## + +Presently manual. I hope to make org-d20 available from a popular +online repository soon. ## Usage ## @@ -33,7 +38,8 @@ modifiers, if you want to use org-d20's combat tracker. You can either end the Org-file with a footer like this: # Local Variables: - # eval: (org-d20-mode 1) + # mode: org + # mode: org-d20 # org-d20-party: (("Zahrat" . 2) ("Ennon" . 4) ("Artemis" . 5)) # End: @@ -41,6 +47,22 @@ or start it with a first line like this: # -*- mode: org; mode: org-d20; org-d20-party: (("Zahrat" . 0) ("Anca" . 1)) -*- +Then close and reopen the file. Emacs will probably ask you to +confirm that the value for org-d20-party that you've supplied is safe. + +The following bindings should then be available: + +- -- start a combat, or advance the turn/round counter + for an existing combat, depending on point +- S- -- add new monsters to an existing combat +- -- apply damage to the monster at point +- S- -- evaluate the dice expression (e.g. `4d10`) at + point +- -- prompt for dice expression and evaluate it +- S- -- roll the last dice expression again +- -- roll d20, with advantage and disadvantage shown +- S- -- roll percentile dice + ## Bugs/patches ## Please report bugs and submit patches by e-mail to diff --git a/TODO.md b/TODO.md index 4a90b4f..0189061 100644 --- a/TODO.md +++ b/TODO.md @@ -1,7 +1,6 @@ Soon ---- -- Much more detail in README.md for new users - Dice expression roller shows results for each die - [Submit to MELPA](https://github.com/melpa/melpa/blob/master/CONTRIBUTING.org#making-your-package-ready-for-inclusion) -- cgit v1.2.3