update readme #25
Merged
update readme #25
Conversation
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
amatissart
reviewed
Feb 7, 2018
README.md
Outdated
| ## Dataset quality test | ||
| :construction: how we plan to ensure the quality of the released dataset :construction: | ||
| :construction: how we plan to ensure the quality of the released dataset. Contributions welcomed in issue #4 :construction: |
amatissart
approved these changes
Feb 7, 2018
antoine-de
reviewed
Feb 7, 2018
README.md
Outdated
|
|
||
| ## Use cases | ||
| `./target/release/cosmogony -i /path/to/your/file.osm.pbf --libpostal /path/to/libpostal/rules/folder/ -o /path/for/output/file` |
There was a problem hiding this comment.
it's better to use cargo run --release
cargo run --release -- -i /path/to/your/file.osm.pbf --libpostal /path/to/libpostal/rules/folder/ -o /path/for/output/file
README.md
Outdated
| ## Use cases | ||
| `./target/release/cosmogony -i /path/to/your/file.osm.pbf --libpostal /path/to/libpostal/rules/folder/ -o /path/for/output/file` | ||
|
|
||
| Check out cosmogony help for more options: `./target/release/cosmogony -h` |
README.md
Outdated
|
|
||
| We do not forbid ourself however to use other data sources (with compliant license), but we don't want `cosmogony` to be too complex and we do not aim to recreate the great [WhosOnFirst](https://www.whosonfirst.org/) ([see below](#See-also)) | ||
| #### Build |
There was a problem hiding this comment.
I think you should add a note telling the update the submodules
update the git submodules:
`git submodule update --init`
README.md
Outdated
| * GEOS (`apt-get install libgeos-dev`) | ||
|
|
||
| Then, build cosmogony: `cargo build --release` | ||
|
|
There was a problem hiding this comment.
I would put a Use subsection
README.md
Outdated
| * rust (`curl https://sh.rustup.rs -sSf | sh`) | ||
| * GEOS (`apt-get install libgeos-dev`) | ||
|
|
||
| Then, build cosmogony: `cargo build --release` |
There was a problem hiding this comment.
maybe add a section on the unit tests ?
There was a problem hiding this comment.
you don't actually need to run the tests if you just want to use cosmogony. This may be in a contribute section, what do you think ?
There was a problem hiding this comment.
yes a contribute section is nice
antoine-de
approved these changes
Feb 8, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.