From e4b89529ee2fa0eebf1ed75577c96d7132aaaa32 Mon Sep 17 00:00:00 2001 From: Sammi De Guzman Date: Tue, 26 Sep 2023 16:11:25 -0700 Subject: [PATCH] doc Update README --- README.md | 91 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 51 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index a99e08585..71e4d4224 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,29 @@ -# Plover - -> Bringing stenography to everyone. - -[![CI badge]][CI link] - -| [Homepage][] | [Releases][] | [Wiki][] | [Blog][] | [Google Group][] | [Discord Chat][] | -|--------------|--------------|----------|----------|------------------|------------------| +

+ Plover logo +

+ +

Plover

+ +

Bringing stenography to everyone.

+ +

+ + Latest release + + License + + CI status + + + ReadTheDocs + + + Plover Discord + +

+ +| [Homepage][] | [Wiki][] | [Blog][] | [Google Group][] | +| ------------ | -------- | -------- | ---------------- | - [About](#about) - [Installation](#installation) @@ -52,8 +70,8 @@ When making a new issue, fill out the form as best you can so that we can help you quickly. If you are looking for more general support (i.e. you don't have a -specific issue), consider joining the community. We are active on the -[Discord Chat][], a live chatroom service; and on the [Google Group][], +specific issue), consider joining the community. We are active on +[Discord](https://discord.gg/0lQde43a6dGmAMp2), a live chatroom service; and on the [Google Group][], a more traditional mailing list. ## Contributing @@ -87,8 +105,7 @@ including [StenoJig][] (JavaScript) and [StenoTray][] (Java). some interesting challenges. Please drop in to the Discord server to brainstorm with users and the developers. - Open Steno has websites that accept contributions, including the - [Open Steno Project Homepage][Open Steno Project] ([source][Open - Steno Project Homepage Source]) and [Plover's Homepage][Homepage] + [Open Steno Project Homepage][Open Steno Project] ([source][Open Steno Project Homepage Source]) and [Plover's Homepage][Homepage] ([source][Homepage Source]). ## Development Environment and Building @@ -102,31 +119,25 @@ Please follow through for your system: - [Linux][Linux README] - [Mac][macOS README] - [Beginner's Guide]: https://github.com/openstenoproject/plover/wiki/Beginner's-Guide:-Get-Started-with-Plover - [Blog]: http://plover.stenoknight.com - [Contributing]: https://github.com/openstenoproject/plover/blob/master/CONTRIBUTING.md - [Discord Chat]: https://discord.gg/0lQde43a6dGmAMp2 - [Donate]: http://www.openstenoproject.org/donate - [Google Group]: https://groups.google.com/forum/#!forum/ploversteno - [Homepage Source]: https://github.com/openstenoproject/plover/tree/gh-pages - [Homepage]: http://opensteno.org/plover - [Issues]: https://github.com/openstenoproject/plover/issues?q=is:issue - [License]: https://github.com/openstenoproject/plover/blob/master/LICENSE.txt - [Open Steno Project Homepage Source]: https://github.com/openstenoproject/openstenoproject.github.io - [Open Steno Project]: http://opensteno.org - [Mascot]: http://plover.stenoknight.com/2010/10/new-logo.html - [Releases]: https://github.com/openstenoproject/plover/releases - [StenoJig]: https://github.com/JoshuaGrams/steno-jig - [StenoTray]: https://github.com/SmackleFunky/StenoTray - [Supported Hardware]: https://github.com/openstenoproject/plover/wiki/Supported-Hardware - [Troubleshooting Common Issues]: https://github.com/openstenoproject/plover/wiki/Troubleshooting:-Common-Issues - [Wiki]: https://github.com/openstenoproject/plover/wiki - [installation guide]: https://github.com/openstenoproject/plover/wiki/Installation-Guide - [morinted/plover\_icons]: https://github.com/morinted/plover_icons - - [Windows README]: https://github.com/openstenoproject/plover/blob/master/windows/README.md - [Linux README]: https://github.com/openstenoproject/plover/blob/master/linux/README.md - [macOS README]: https://github.com/openstenoproject/plover/blob/master/osx/README.md - - [CI Badge]: https://github.com/openstenoproject/plover/actions/workflows/ci.yml/badge.svg?branch=master - [CI Link]: https://github.com/openstenoproject/plover/actions/workflows/ci.yml?query=branch%3Amaster +[Beginner's Guide]: https://github.com/openstenoproject/plover/wiki/Beginner's-Guide:-Get-Started-with-Plover +[Blog]: http://plover.stenoknight.com +[Contributing]: https://github.com/openstenoproject/plover/blob/master/CONTRIBUTING.md +[Donate]: http://www.openstenoproject.org/donate +[Google Group]: https://groups.google.com/forum/#!forum/ploversteno +[Homepage Source]: https://github.com/openstenoproject/plover/tree/gh-pages +[Homepage]: http://opensteno.org/plover +[Issues]: https://github.com/openstenoproject/plover/issues?q=is:issue +[License]: https://github.com/openstenoproject/plover/blob/master/LICENSE.txt +[Open Steno Project Homepage Source]: https://github.com/openstenoproject/openstenoproject.github.io +[Open Steno Project]: http://opensteno.org +[Mascot]: http://plover.stenoknight.com/2010/10/new-logo.html +[StenoJig]: https://github.com/JoshuaGrams/steno-jig +[StenoTray]: https://github.com/SmackleFunky/StenoTray +[Supported Hardware]: https://github.com/openstenoproject/plover/wiki/Supported-Hardware +[Troubleshooting Common Issues]: https://github.com/openstenoproject/plover/wiki/Troubleshooting:-Common-Issues +[Wiki]: https://github.com/openstenoproject/plover/wiki +[installation guide]: https://github.com/openstenoproject/plover/wiki/Installation-Guide +[morinted/plover\_icons]: https://github.com/morinted/plover_icons +[Windows README]: https://github.com/openstenoproject/plover/blob/master/windows/README.md +[Linux README]: https://github.com/openstenoproject/plover/blob/master/linux/README.md +[macOS README]: https://github.com/openstenoproject/plover/blob/master/osx/README.md