From 55629cd1b9095f26c336d5f3b6b05bdc094925a9 Mon Sep 17 00:00:00 2001 From: Austin Wise Date: Mon, 5 Aug 2024 20:08:21 -0700 Subject: [PATCH] Phrasing --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9135954..1f75c07 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,10 @@ 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 @@ -22,7 +23,7 @@ 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 ``` @@ -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 ```