-
-
Notifications
You must be signed in to change notification settings - Fork 226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adjust readme and martin book #1253
Merged
Merged
Changes from 6 commits
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
4a9c4e8
Update installation.md
sharkAndshark 00c6a20
Remove API
sharkAndshark 358f044
Remove Running Martin Service
sharkAndshark c07b924
Remove installation from readme
sharkAndshark 257ff15
Remove Re-use Martin as a library
sharkAndshark 7450a26
Add Martin as a library to book
sharkAndshark 935b81d
Use x64 instead of amd-64
sharkAndshark 6d3ac61
Add helpful doc links to readme
sharkAndshark 5253789
Add Re-use-Martin-as-a-library.md to SUMMARY.md
sharkAndshark 2bcc365
wip
sharkAndshark 1f345ee
wip
sharkAndshark efbd7ba
wip
sharkAndshark 75eb52c
wip
sharkAndshark 05fc15e
Update quick start with windows
sharkAndshark 85f904c
just fmt-md
sharkAndshark 4987ddb
wip
sharkAndshark 9c11229
add quick-start with linux and cleanup
sharkAndshark 179525f
temporally remove the quick start link to pass link check
sharkAndshark 40a8524
adjust images
sharkAndshark c7efd5b
adjust case
sharkAndshark ea63a34
adjust images
sharkAndshark 04bd462
update doc about martin as a library
sharkAndshark eb4c6ee
fix links
sharkAndshark e12aa97
Replace image
sharkAndshark f64097b
Merge branch 'main' into readme
nyurik adbe489
Merge branch 'main' into readme
nyurik 6d9f0f9
reworked documentation
nyurik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Re-use Martin as a library | ||
sharkAndshark marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Martin can be used as a standalone server, or as a library in your own Rust application. When used as a library, you can use the following features: | ||
|
||
* **postgres** - enable PostgreSQL/PostGIS tile sources | ||
* **pmtiles** - enable PMTile tile sources | ||
* **mbtiles** - enable MBTile tile sources | ||
* **fonts** - enable font sources | ||
* **sprites** - enable sprite sources |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Like this?
Helpful Martin docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, but without the header - just a few links. We may also want to add a "quick start" - makes novice users go there first