Skip to content

Commit

Permalink
Cosmetic tweaks
Browse files Browse the repository at this point in the history
  - Reflowed paragraphs altered in recent edits.

  - Corrected hyphens to em-dashes.
  • Loading branch information
danwilliams committed Jun 15, 2023
1 parent cc21aa8 commit 7540297
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ If you are here to read the content (for instance if you are using a Git system
to preview the Markdown, such as GitHub or Gitea), start there.

An example showing available [Markdown features](content/rustmark/features.md)
is also
provided, along with some [Guidelines](content/rustmark/guidelines.md) for use.
is also provided, along with some [Guidelines](content/rustmark/guidelines.md)
for use.


## Features
Expand Down Expand Up @@ -110,7 +110,7 @@ simple addition to make.
## Why Rustmark?

The intention is to provide a simple system that is easy to maintain, and
focused on developer documentation - or at least, documentation written by
focused on developer documentation or at least, documentation written by
people who are comfortable working in Markdown with text editors, and committing
their changes to a Git repository.

Expand All @@ -124,7 +124,7 @@ used due to the popularity of Jira, lags a long way behind.

Notion is a great product, with some excellent and powerful features, and it is
also very easy to use. However, it does not feature any kind of approval
process, meaning that it is all too easy for incorrect information to creep in -
process, meaning that it is all too easy for incorrect information to creep in
and the more pages there are to keep an eye on, the worse this problem becomes.
Although Notion does have page edit history, and change alerts, it is not
possible to require that changes are approved before they are published. Locking
Expand Down Expand Up @@ -225,9 +225,8 @@ built into the binary or left externally to be deployed alongside it.
## Usage

The Rustmark repository is designed so that it can be forked, and content added.
As such,
it is best to keep in line with the existing structure and intended usage, to
make updates from the upstream repository easier to merge and apply.
As such, it is best to keep in line with the existing structure and intended
usage, to make updates from the upstream repository easier to merge and apply.

Note that Rustmark is not designed to be used as a library, and its existence
on [crates.io](https://crates.io/crates/rustmark) is as a binary. This is to
Expand Down

0 comments on commit 7540297

Please sign in to comment.