From 667ab0c19fb038e0e8dfc9891efef4f8cb55f946 Mon Sep 17 00:00:00 2001 From: Bauke Date: Mon, 3 Oct 2022 23:38:30 +0200 Subject: [PATCH] Rewrite the readme. --- README.md | 35 +++++++---------------------------- 1 file changed, 7 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index d691cd9..a3d7821 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,17 @@ -# Tildes Wiki Sitemap +# Tildes 📍 Wiki Sitemap -> Generates a Markdown file with all group wiki pages of Tildes. +> **Tildes Wiki sitemap generator.** ## Installation -### Binary +### Binaries -Precompiled binaries are available [here](https://git.holllo.cc/Bauke/tildes-wiki-sitemap/releases). +Precompiled `x86_64-unknown-linux-gnu` binaries are available on the [Releases page](https://git.bauke.xyz/Bauke/tildes-wiki-sitemap/releases). -### Source +## Feedback -Requires [Rust and Cargo](https://www.rust-lang.org/tools/install) to be installed. - -```sh -git clone https://git.holllo.cc/Bauke/tildes-wiki-sitemap.git -cd tildes-wiki-sitemap -cargo build --release -mv target/release/tildes-wiki-sitemap ./ -``` - -## Usage - -Make sure the file is executable, then run it. A `sitemap.md` file will be created with the results. - -```sh -chmod +x ./tildes-wiki-sitemap -./tildes-wiki-sitemap -less sitemap.md -``` - -## Previous Version - -If you're looking for the previous version of this program written in Go, [click here](https://git.holllo.cc/Bauke/tildes-wiki-sitemap/src/commit/18a96e9d541fd1e231574ceec4d4bdf5783e3b5f) to go to the commit before the Rust rewrite. +Found a problem or want to request a new feature? Message [@Bauke](https://tildes.net/user/Bauke/new_message) on Tildes or email [me@bauke.xyz](mailto:me@bauke.xyz) and I'll see what I can do for you. ## License -Open-sourced with the [AGPL-3.0-or-later license](https://git.holllo.cc/Bauke/tildes-wiki-sitemap/src/branch/main/LICENSE). +Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Bauke/tildes-wiki-sitemap/src/branch/main/LICENSE) for more information.