Skip to content

Docs: First Draft of Readme #13

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.

Sign up for GitHub

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

Open
sean-dickinson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: First Draft of Readme #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 12 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,17 @@
# README
# EndsideOut LMS

This README would normally document whatever steps are necessary to get the
application up and running.
## Mission

Things you may want to cover:
[EndsideOut](https://endsideout.org/) is a non-profit organization dedicated to combatting obesity and chronic health conditions by building health literacy and fostering behavior change in underserved communities.
They currently run programs in Baltimore, Maryland and some surrounding counties as well as a remote program in Liberia.

* Ruby version
## This Application
This application serves as an LMS tool for EndsideOut to deliver their health literacy curriculum to students and parents in their programs, as well as track statistics and trends.

* System dependencies
## Ruby for Good
EndsideOut is one of many projects initiated and run by Ruby for Good. You can find out more about Ruby for Good at https://rubyforgood.org

* Configuration

* Database creation

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...
## Current Status
This project is currently in active early development and is not yet ready for open source contributors.
We are currently working with the organization to determine exactly what the application needs to do and how it should work.
Once the requirements are more clearly defined, we will be opening the project up for contributions.
Loading