Skip to content

Commit

Permalink
Improvements to better follow awesome-list guidelines (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
morinted authored Apr 10, 2021
1 parent 6668693 commit 08974c5
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 26 deletions.
22 changes: 12 additions & 10 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ project you agree to abide by its terms.

---

Ensure your pull request adheres to the following guidelines:

- As a general rule, try only to submit other people's content. **An awesome list is not a tool for self-promotion.**
- New sections are created as appropriate.
- Sort section content alphabetically.
- Do not repeat "Plover" if it's not necessary (e.g. "Plover Dict Commands" becomes simply "Dict Commands").
- Tell us not just what the awesome thing is, but why it's awesome.

Thank you for your suggestions!

1. See the [awesome manifesto](https://github.com/sindresorhus/awesome/blob/main/awesome.md) to learn what Awesome lists are all about.
2. Everyone is welcome to review open pull requests and make suggestions!
3. Ensure your pull request adheres to the following guidelines:
- As a general rule, try only to submit other people's content. **An awesome list is not a tool for self-promotion.**
- This is a curated list, not an exhaustive one. Please only suggest items that you would consider "awesome" and err on the side of including too little!
- New sections should be created as needed.
- Sort section content alphabetically, sort sections by generality (more general sections first, followed by more specific or niche use-cases.)
- Do not repeat "Plover" if it's not necessary (e.g. "Plover Dict Commands" becomes simply "Dict Commands").
- Tell us not just **what** the awesome thing is, but **why** it's awesome.
- Links should strictly follow the format that is used everywhere in the list: `- [Title](link.com) - Description in sentence case with a period at the end.`

Looking forward to your contributions to this list!

## Updating your PR

Expand Down
26 changes: 10 additions & 16 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Awesome Plover [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)

> A curated list of dictionaries and plugins for Plover open source stenography.
<!--lint ignore no-double-link -->
[<img src="https://raw.githubusercontent.com/openstenoproject/plover/master/plover/assets/plover-icon.svg" align="right" width="10%">](https://github.com/openstenoproject/plover)

> A curated list of dictionaries and plugins for Plover, the open source stenography software.
<!--lint ignore no-double-link -->
[Plover](https://github.com/openstenoproject/plover) is a free, open source stenography engine. It allows individuals to replace their keyboard and write into any program at speeds of over 200 words per minute.

## Contents

- [Dictionaries](#dictionaries)
- [Plugins](#plugins)
- [Contribute](#contribute)


## Dictionaries

Dictionaries and python dictionaries to make the Plover experience better.

### Collections

- [Di's Steno Dictionaries](https://github.com/didoesdigital/steno-dictionaries) - A wonderfully organized list of dictionaries from the maker of Typey Type with everything from removing misstrokes from Plover Theory, to advice on computer use, alternative locales, and programming.
Expand All @@ -26,31 +27,24 @@ Dictionaries and python dictionaries to make the Plover experience better.

### Commands

Plugins that control your system or Plover itself.

- [Dict Commands](https://github.com/KoiOates/plover_dict_commands) - Enable, disable, and reorder dictionaries with steno strokes.
- [System Switcher](https://github.com/nsmarkop/plover_system_switcher) - Switch between different steno systems on the fly, critical for multilingual stenography.
- [VLC Commands](https://github.com/benoit-pierre/plover_vlc_commands) - Play, pause, seek, and adjust the rate of VLC media player with steno strokes. Paired with your favorite text editor, it makes an excellent transcription tool. It even has support for outputting the current timestamp.

### Dictionary Formats

Plugins that add new dictionary types.

- [Python Dictionary (.py)](https://pypi.org/project/plover-python-dictionary/) - Dictionaries that are small python scripts -- the possibilities are limitless! A few extremely useful Python dictionaries make this plugin a must-have.

### Text Macros

Plugins that affect text output and translation.

<!--lint ignore no-repeat-punctuation -->
- [Fancy Text](https://github.com/psethwick/plover_fancytext) - Switch between typing in all sorts of exotic modes. It's essential if you want to keep up with the kids, supporting everything from "vaporwave" to "sARcASm" to "c,,ry ttypinng,".
- [Repeat last translation](https://github.com/nsmarkop/plover_last_translation) - Repeat the last translation (word, shortcut, emoji, etc.) with a single stroke.

### Tools

Widget-style plugins.
### Tools and Widgets

- [Spectra Lexer](https://github.com/fourshade/spectra_lexer) - A beautiful tool that explains why words are stroked the way that they are in your dictionary.

## Contribute
## Contributing

Contributions welcome! Read the [contribution guidelines](contributing.md) first.
If you have a favorite Plover plugin or dictionary that isn't listed, it would be awesome if you added it. Please read the [contribution guidelines](contributing.md) first.

0 comments on commit 08974c5

Please sign in to comment.