https://github.com/openstenoproject/stenodict

Stenodict aims to help shape how to use stenography in our modern world
https://github.com/openstenoproject/stenodict

Last synced: 8 months ago
JSON representation

Stenodict aims to help shape how to use stenography in our modern world

• Host: GitHub
• URL: https://github.com/openstenoproject/stenodict
• Owner: openstenoproject
• Created: 2015-10-22T19:24:22.000Z (over 10 years ago)
• Default Branch: gh-pages
• Last Pushed: 2023-01-20T00:49:13.000Z (over 3 years ago)
• Last Synced: 2025-01-29T11:11:25.871Z (over 1 year ago)
• Homepage: http://www.openstenoproject.org/stenodict
• Size: 952 KB
• Stars: 23
• Watchers: 10
• Forks: 5
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# README

Stenodict runs on [Jekyll](https://jekyllrb.com/).

## Adding a dictionary

1. Fork Stenodict and checkout `gh-pages`.

2. Copy template dictionary info Markdown file:

        $ cp _dictionaries/_template_dictionary.md _dictionaries/YOUR_DICTIONARY_NAME.md

3. Add your dictionary to the `dictionaries/` directory. For example:

        $ cp dictionaries/_template_dictionary.json _dictionaries/YOUR_DICTIONARY_NAME.json

        $ $EDITOR _dictionaries/YOUR_DICTIONARY_NAME.json

4. Edit your new dictionary file and Markdown info file about your new dictionary. Check your dictionary using `jsonlint`:

        $ jsonlint dictionaries/*.json

5. Make a [Pull Request to Stenodict's `gh-pages` branch](https://github.com/openstenoproject/stenodict/pull/new/gh-pages).

## Running Jekyll

1. Install bundler at the command prompt if you haven't yet:

        $ gem install bundler

2. At the command prompt, install gems from `Gemfile`, including `jekyll`:

        $ bundle install

3. Serve Jekyll site:

        $ bundle exec jekyll serve

4. Browse to .