Skip to content

Commit

Permalink
Phrasing
Browse files Browse the repository at this point in the history
  • Loading branch information
AustinWise committed Aug 6, 2024
1 parent b1f6264 commit 55629cd
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,18 @@ Non goals include:

* Support for multiple users.

Phrased in another way, the goal of this project is to create something roughly
like [Gollum](https://github.com/gollum/gollum), but does not take half an hour
to `gem install` on a low-powered Chromebook.
Phrased in another way, the goal of this project is to create something that behaves
like [Gollum](https://github.com/gollum/gollum) be installs easily and quickly. This is contrasted
with the Gollum install experience of having to deal with the slowness and complication of setting
up a Ruby environment and running `gem install`.

## Getting started

See the [smeagol.dev website](https://smeagol.dev/) for more install options.

If you use the Rust programming language, you can also install this tool using Cargo:

```
```bash
cargo install smeagol-wiki
```

Expand All @@ -32,7 +33,7 @@ Extract the `smeagol-wiki` executable from the compressed archive.
containing the Markdown files you want to serve. You can pass
a command line argument to it to specify the directory:

```
```bash
smeagol-wiki ~/wiki
```

Expand Down

0 comments on commit 55629cd

Please sign in to comment.