Rewrite the readme.
This commit is contained in:
parent
4808ed8244
commit
667ab0c19f
35
README.md
35
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
|
## 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.
|
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.
|
||||||
|
|
||||||
```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.
|
|
||||||
|
|
||||||
## License
|
## 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.
|
||||||
|
|
Loading…
Reference in New Issue