This repository has been archived by the owner on Jan 2, 2025. It is now read-only.
Update to Readme (fixes #1) #29
Merged
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
bburns632
force-pushed
the
feature/READMEupdate
branch
from
e808e6d to
f2d276c
Compare
jameslamb
suggested changes
Aug 19, 2019
|
|
||
| ```bash | ||
| docker build -t groundhog -f Dockerfile . | ||
| docker build -t groundhog -f Dockerfile-app . |
There was a problem hiding this comment.
we have #5 so this will get reverted, but I like the idea of leaving that alone for someone who is less familiar with open source to pick up as a "good first issue".
So I support the change in this PR.
README.md
Outdated
| @@ -37,6 +39,10 @@ To stop the container by name (if you used the `--name` tag when launching it), | |||
| docker stop groundhog_server | |||
| ``` | |||
|
|
|||
| *** | |||
| ## Clients | |||
| With the docker container running, choose a client to get and append elevation data to your dataset. | |||
There was a problem hiding this comment.
Nothing about the clients relies on the fact that the app is running in .a container. It could just as easily be running on some dedicated server.
Can you change With the docker container running, to Given a running instance of the service,?
| # groundhog | ||
| `groundhog` is a service and client libraries to access NASA's publicly available surface elevation data, [SRTM](https://www2.jpl.nasa.gov/srtm/). Given a table with GPS information, this package provides utilities to enrich that dataset with elevation and slope features. Just load the container and one of the clients, and you're all set! |
There was a problem hiding this comment.
could you put a blank line between headings and their body content?
bburns632
force-pushed
the
feature/READMEupdate
branch
from
f2d276c to
d2fc182
Compare
|
@jameslamb , good suggestions. Here's a revised PR. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
As raised in #1 , the README was a little confusing for a new user. This PR mainly:
Another major assumption is that the quotes were placeholders. This PR can be modified with those back in if that was a mistake.