README.md in gm-notepad-0.0.10 vs README.md in gm-notepad-0.0.11
- old
+ new
@@ -2,10 +2,14 @@
A command-line tool to help with your GM-ing.
## To install
+First, you will need a working copy of Ruby. I recommend following the [instructions over at rbenv's Github page](https://github.com/rbenv/rbenv#installation).
+
+Next, you'll want to install the `gm-notepad` gem.
+
`$ gem install gm-notepad`
## Background
On a commute home from work, while listening to [Judd Karlman's "Daydreaming about Dragons" podcast](https://anchor.fm/daydreaming-about-dragons/)
@@ -59,11 +63,10 @@
-r, --report_config Dump the configuration data (Default: false)
-p, --path=PATH Path(s) for {table_name}.<config.table_extension> files (Default: ["."])
-f, --filesystem_directory=DIR Path to dump tables (Default: ".")
-x, --table_extension=EXT Extension to use for selecting tables (Default: ".txt")
-t, --timestamp Append a timestamp to the note (Default: false)
- -d, --defer_output Defer output until system close (Default: false)
Color options:
-i, --skip-interactive-color Disable color rendering for interactive buffer (Default: false)
-o, --with-output-color Enable color rendering for output buffer (Default: false)
@@ -77,11 +80,10 @@
Which writes the following to the `interactive` buffer (eg. `$stderr`)::
```console
# Configuration Parameters:
# config[:report_config] = true
-# config[:defer_output] = false
# config[:filesystem_directory] = "."
# config[:interactive_buffer] = #<IO:<STDERR>>
# config[:interactive_color] = true
# config[:output_color] = false
# config[:list_tables] = false
@@ -225,18 +227,20 @@
- [X] Enable "up" and "down" to scroll through history
- [X] Add index name when rendering table entries
- [ ] Gracefully handle loading a malformed data file (maybe?)
- [X] Add concept of history
- [X] When expanding tables account for line expansion (via \n and \t)
-- [ ] Separate the InputHandler into pre-amble (e.g. allow overrides to where we are writing, determine what command we are writing)
+- [X] Separate the InputHandler into pre-amble (e.g. allow overrides to where we are writing, determine what command we are writing)
- [X] Create a configuration object that captures the initial input (reduce passing around parameters and persisting copies of the config)
- [ ] Add concept of "journal entry"; its not a table (perhaps) but something that you could capture notes.
- [X] Add column handling `{table[][]}`
-- [ ] Gracefully handle cell lookup when named cell for entry is not found
+- [X] Gracefully handle cell lookup when named cell for entry is not found
- [X] Support `\{\{table}-name}` You should be able to do `\{\{culture}-name}` and first evaluate to `{arabic-name}` and then get a value from the `arabic-name` table
- [X] Ensure index names are lower-case
- [ ] Hit 100% spec coverage
- [ ] Create a "To Render Object"; When you parse the input, you push relevant lines to that "To Render Object". When you look at a table, you want to know what the column names are.
+- [X] Remove "defer" printing concept
+- [ ] Add ability to shell out; I would love to leverage the [swnt](https://github.com/nboughton/swnt) command line tool
### Stretch TODO
- [ ] Handle a `.gm-notepadrc` to inject default configurations
- [ ] Allow configuration to specify colors