Skip to content
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

More Descriptive README Doc #1

Open
Haoen-Cui opened this issue Aug 7, 2019 · 2 comments
Open

More Descriptive README Doc #1

Haoen-Cui opened this issue Aug 7, 2019 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Haoen-Cui
Copy link

@Chronocook @jameslamb Thanks for open sourcing this great project!

I read through the README file but don't think I get the purpose and typical usage of this package. It seems to me that this package contains helper functions to generate slope features based on numeric values recorded at various geo-locations.

Would you consider adding more descriptive docs? I am looking for

  • a short paragraph that describes the main functionalities of the package
  • a few typical usages with outputs and preferably some visuals if that helps

I think the above will help people get familiar with and adopt the package.

@jameslamb jameslamb added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 7, 2019
@bburns632
Copy link
Contributor

In this readme, I would add a few lines of code to the readme to allow the example to work from any directory a user may open in their terminal.

@bburns632
Copy link
Contributor

I have this in process. Will wait to submit a PR until #23 is resolved, and I can test the end to end workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants