Skip to content

Commit 3bfb57c

Browse files
committed
update readme - formatting, details
1 parent 3645cb2 commit 3bfb57c

File tree

3 files changed

+8
-50
lines changed

3 files changed

+8
-50
lines changed

README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
1. [Overview](#-overview)
1212
2. [Features](#%EF%B8%8F-features)
1313
3. [Installation](#-installation)
14-
4. [Usage](#-usage)
15-
- [Setting the API Key](#set-api-key)
16-
- [Generating maps](#generate-maps)
14+
4. [Usage](#%EF%B8%8F-usage)
15+
- [Setting the API Key](#-setting-your-api-key)
16+
- [Generating maps](#%EF%B8%8F-generate-maps)
1717
- [Generate a procedural map with seed and size](#generate-a-procedural-map-with-seed-and-size)
1818
- [Generate a procedural map with seed and size (staging branch)](#generate-a-procedural-map-with-seed-and-size-staging-branch)
1919
- [Generate a procedural map with random seed](#generate-a-procedural-map-with-random-seed)
@@ -22,10 +22,10 @@
2222
- [Generate maps from a csv file (procedural and custom)](#generate-maps-from-a-csv-file-procedural-and-custom)
2323
- [Download generated maps](#download-generated-maps)
2424
- [Download generated maps to a specified directory](#download-generated-maps-to-a-specified-directory)
25-
- [Opening maps in the browser](#🌐-opening-maps-in-the-browser)
26-
- [Using a `csv` file](#📚-using-a-csv-file)
27-
6. [Storage Locations](#where-is-stuff-stored)
28-
7. [Disclaimers](#-disclaimers)
25+
- [Opening maps in the browser](#-opening-maps-in-the-browser)
26+
- [Using a `csv` file](#-using-a-csv-file)
27+
6. [Storage Locations](#-file-structurelocations)
28+
7. [Disclaimers](#%EF%B8%8F-disclaimers)
2929

3030
## 📖 Overview
3131

@@ -49,7 +49,7 @@ This tool takes map parameter input either via command line or `csv` file (colum
4949

5050
### Quick Install
5151

52-
If you just want to get up and running quickly, we provide a binary for just aboout every platform. You can download the binary for your platform from our [releases](https://github.com/maintc/rustmaps-cli/releases) page.
52+
If you just want to get up and running quickly, the project provides a binary for `macOS`, `Linux`, and `Windows`. You can download the binary for your platform from the [releases](https://github.com/maintc/rustmaps-cli/releases) page.
5353

5454
### Developers and golang people
5555

@@ -73,7 +73,6 @@ Available Commands:
7373
completion Generate the autocompletion script for the specified shell
7474
generate Generate custom and procedural maps
7575
open Open generated maps in the browser
76-
tutorial Run through the tutorial and learn to get started
7776

7877
Flags:
7978
-h, --help help for rustmaps

docs/examples/generate.yml

-41
This file was deleted.

docs/images/mainloot-logo-rm.png

-13.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)