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

Readme changes #279

Open
wpears opened this issue Jan 28, 2015 · 2 comments
Open

Readme changes #279

wpears opened this issue Jan 28, 2015 · 2 comments

Comments

@wpears
Copy link
Member

wpears commented Jan 28, 2015

The README needs quite a few updates.

  • Setup needs to be clarified, specifically with regard to setting up postgres/postgis. The readme doesn't say anything about getting a database up and running, but this is a requirement for running the data setup scripts.
  • The purpose/scope of this repository needs to be clarified. It's unclear from the readme what the code/data in the repository does. Running through the setup will get the data setup for API calls, but nothing is said about how to setup the app itself (both front and back-end).
  • See proposed changes in https://github.com/wpears/mapusaurus/blob/f56cf87c86ec4105fa09b5e0f3af8ea74798ca6d/notes.txt (mostly incorporated)
@wpears
Copy link
Member Author

wpears commented Jan 28, 2015

There also needs to be some info on what postgis plugins/templates/addons are needed.

@wpears
Copy link
Member Author

wpears commented Jan 28, 2015

A reference to API.md in the readme would be helpful

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant