From 5837d2d4ee2d709ebf3b9aa345c951fe4014b492 Mon Sep 17 00:00:00 2001 From: David Masad Date: Sat, 30 Jan 2021 14:41:51 -0500 Subject: [PATCH] Minor docs update --- Readme.md | 13 +++++++++++-- Tutorial.md => docs/Tutorial.md | 0 2 files changed, 11 insertions(+), 2 deletions(-) rename Tutorial.md => docs/Tutorial.md (100%) diff --git a/Readme.md b/Readme.md index 1e7dde7..3a4920f 100644 --- a/Readme.md +++ b/Readme.md @@ -1,6 +1,8 @@ # StoryManager -StoryManager is a lightweight add-on for Twine + SugarCube implementing parameterized storylets. It's intended for people who are comfortable using JavaScript along with Twine, and want to use it to manage data for their interactive fiction. +StoryManager is a lightweight add-on for Twine + SugarCube implementing parameterized storylets. It's intended for people who are comfortable using JavaScript along with Twine, and want to use it to manage data and world-models for their interactive fiction. + +You can use it in the Twine interactive editor, but at the moment it's probably best used with the [Tweego](https://www.motoslave.net/tweego/) command-line tool. ## How to use it @@ -83,4 +85,11 @@ I have a few Twine hobby projects in various stage of completion, and I found my - [ ] Weighted random choice - [ ] Explore replacing storylet generators returning arrays with the `yield` keyword? **Pro:** produces cleaner code; **Con:** requires users to understand `yield` and remember to use the function * notation. - [ ] Add storylet code to passages (as comments, a-la Tiny-QBN?) -- [ ] CSS styling (probably to go with widgets/macros?) \ No newline at end of file +- [ ] CSS styling (probably to go with widgets/macros?) + +Pull requests welcome! + +## License + +MIT License + diff --git a/Tutorial.md b/docs/Tutorial.md similarity index 100% rename from Tutorial.md rename to docs/Tutorial.md