Adjust readme and martin book #1253
Conversation
| @@ -14,107 +14,6 @@ Additionally, there are [several tools](https://maplibre.org/martin/tools.html) | |||
|
|
|||
| See [Martin book](https://maplibre.org/martin/) for complete documentation. | |||
|
|
|||
| ## Installation | |||
There was a problem hiding this comment.
I think we should create some something like a list of important information, and point it to the book - e.g. installation should point directly to the installation section, etc. Just the most important topics, not everything?
There was a problem hiding this comment.
There was a problem hiding this comment.
Yes, but without the header - just a few links. We may also want to add a "quick start" - makes novice users go there first
README.md
Outdated
| * [Installation](https://maplibre.org/martin/installation.html) | ||
| * Running with [CLI](https://maplibre.org/martin/run-with-cli.html) or [configuration file](https://maplibre.org/martin/config-file.html) | ||
| * [Usage and API](https://maplibre.org/martin/using.html) | ||
| <!-- * [Quick Start](https://maplibre.org/martin/quick-Start.html) --> |
There was a problem hiding this comment.
To bypass the markdwon link check, this line is removed temporally. Will be added after this get merged.
|
will review shortly. One thing for sure - i don't think we want to use case-sensitive dir name like |
|
P.S. and same for the filename -- Perhaps a better name is |
|
Great work, thanks!!! It gave me a good start to continue improving it. Especially big thx for the QGIS doc images, they make things much easier for the novice users. |
Try to fix #1245
Add or keep
Get Startedto readme, it must be easy to take, likecurl -O ..and thenmartin http://xxx.demo.pmtilesI guess? ORdocker run ..with a small http://xxx.demo.pmtiles, do we have some host to serve a demo pmtiles file?Licensein readmeMove or remove from
readme.mdRe-use Martin as a libraryto bookRunning Martin ServiceAPIfrom readme