Read Me Text - Githubissues

codeforkansascity / CommunityKC

Visualization and management of community-based projects

http://communitykc.org

GNU General Public License v2.0

3 stars 4 forks source link

Read Me Text #62

Open silasck opened 8 years ago

silasck commented 8 years ago

@lacrone You brought up at Hack Across America that we should start working on the 'Read Me' text. What exactly should go in there? Was it just a way to chronicle what we've been doing so that this project can be passed on to anyone else who wishes to work on it in the future?

lacrone commented 8 years ago

Did I mention that? Basically the ReadME is just a description of the project, and the process for deploying your own version. The readMe we have is not bad as i recall but we should definitely look it over to see if updates need to be made.

zmon commented 8 years ago

From our GitHub pushstart

What a README should do and be:

Use it to orient people to your project.
Project needs (if any), ie designers, javascript coders...
It should be simple and short.
Could contain:
- a clear description of the project
- how and why you would use it
- list of authors
- instructions on how to contribute, fork/pull, issues
- instructions on use and/or install

Neighborhood-Dashboard has a good one. https://github.com/codeforkansascity/Neighborhood-Dashboard

lacrone commented 8 years ago

Also the first iteration of Community KC has one we could adapt for the current version: https://github.com/codeforkansascity/civic-project-mapping

silasck commented 8 years ago

Here's the ReadME Text I have so far:

silasck commented 8 years ago

I'm working on the "Introduction for Developers" part right now. Are there any suggestions for that? Other than mentioning that CKC runs on Druple, it uses HTML/CSS/JavaScript applications, and has its data stored in Google Spread Sheets.

lacrone commented 7 years ago

Data is no longer stored in Google sheets. Saying it uses Drupal with MySQL database is probably sufficient.