Skip to content
This repository
Browse code

Merge branch 'master' of github.com:mission-of-mercy/mission-of-mercy

  • Loading branch information...
commit afeed4e4ec16d406ee96737d6df971550f570d69 2 parents 0cf96b2 + e82dbb3
Jordan Byron jordanbyron authored

Showing 1 changed file with 29 additions and 28 deletions. Show diff stats Hide diff stats

  1. +29 28 README.md
57 README.md
Source Rendered
@@ -2,32 +2,8 @@
2 2
3 3 Clinic management software for Mission of Mercy free dental clinics. Created to streamline patient intake, digital x-ray, and check-out processes during the clinic’s operating hours. Since its creation in 2009 it has been used in Mission of Mercy clinics throughout the United States.
4 4
5   -For the latest information about the software check out [this project's wiki](http://wiki.github.com/mission-of-mercy/mission-of-mercy)
6   -
7   -## Installation
8   -
9   -Mission of Mercy Software is a Ruby on Rails 3.1 application which runs on Ruby 1.9.2 and
10   -[PostgreSQL](http://www.postgresql.org) databases. Other databases like MySQL
11   -or SQLite are not officially supported.
12   -
13   -### Setting Up a Development Copy: Step by Step
14   -
15   -To install a development version of Mission of Mercy, follow these steps:
16   -
17   -1. Fork our GitHub repository: <http://github.com/mission-of-mercy/mission-of-mercy>
18   -2. Clone the fork to your computer
19   -3. If you don't already have bundler installed, get it by running `gem install bundler`
20   -4. Install Qt libraries for capybara-webkit: <https://github.com/thoughtbot/capybara-webkit#readme>
21   -5. Run `bundle install` to install all of the project's dependencies
22   -6. Finally, run `rake setup` to create the required config files, create the database, and seed it with data
23   -
24   -To make things even easier, you can copy and paste this into your terminal once you've got the project cloned to your computer
25   -
26   -```bash
27   -gem install bundler
28   -bundle install
29   -bundle exec rake setup
30   -```
  5 +For the latest information about the software check out [this project's wiki](http://wiki.github.com/mission-of-mercy/mission-of-mercy).
  6 +Or if you'd like to contribute be sure to read the [contribution](#contribute) section below.
31 7
32 8 ## What is Mission of Mercy?
33 9
@@ -48,7 +24,7 @@ It's easy to work on a software project and never see the impact it makes on peo
48 24 - [2011 Connecticut Mission of Mercy clinic](http://youtu.be/aGAEtleugnk)
49 25 - [2011 Georgia Mission of Mercy clinic](http://youtu.be/u4jvLU3RGfU)
50 26
51   -## Contributing
  27 +## Contributing <a href="#contribute" id="contribute" name="contribute">&raquo;</a>
52 28
53 29 Features and bugs are tracked through [Github Issues](https://github.com/mission-of-mercy/mission-of-mercy/issues).
54 30
@@ -62,7 +38,7 @@ Contact Jordan through [GitHub (@jordanbyron)](https://github.com/jordanbyron) o
62 38
63 39 1. If a ticket doesn't exist for your bug or feature, create one on GitHub.
64 40 - **NOTE:** Don't be afraid to get feedback on your idea before you begin development work. In fact it is encouraged. I promise I don't bite ;)
65   -2. Fork the project.
  41 +2. Follow the [Installation](#install) instructions below.
66 42 3. Create a topic branch.
67 43 4. Implement your feature or bug fix.
68 44 5. Add documentation for your feature or bug fix.
@@ -72,6 +48,31 @@ Contact Jordan through [GitHub (@jordanbyron)](https://github.com/jordanbyron) o
72 48 9. Commit and push your changes.
73 49 10. Submit a pull request.
74 50
  51 +## Installation <a href="#install" id="install" name="install">&raquo;</a>
  52 +
  53 +Mission of Mercy Software is a Ruby on Rails 3.1 application which runs on Ruby 1.9.2 and
  54 +[PostgreSQL](http://www.postgresql.org) databases. Other databases like MySQL
  55 +or SQLite are not officially supported.
  56 +
  57 +### Setting Up a Development Copy: Step by Step
  58 +
  59 +To install a development version of Mission of Mercy, follow these steps:
  60 +
  61 +1. Fork our GitHub repository: <http://github.com/mission-of-mercy/mission-of-mercy>
  62 +2. Clone the fork to your computer
  63 +3. If you don't already have bundler installed, get it by running `gem install bundler`
  64 +4. Install Qt libraries for capybara-webkit: <https://github.com/thoughtbot/capybara-webkit#readme>
  65 +5. Run `bundle install` to install all of the project's dependencies
  66 +6. Finally, run `rake setup` to create the required config files, create the database, and seed it with data
  67 +
  68 +To make things even easier, you can copy and paste this into your terminal once you've got the project cloned to your computer
  69 +
  70 +```bash
  71 +gem install bundler
  72 +bundle install
  73 +bundle exec rake setup
  74 +```
  75 +
75 76 ## Authorship
76 77
77 78 Mission of Mercy was originally written by Jordan Byron for the 2009 Connecticut Mission of Mercy dental clinic. During the 2008 CT clinic, Jordan's then employer, Integrity Systems & Solutions, saw areas of the clinic which could benefit from custom software written to fit the flow and "Mash Unit" environment of the clinic. Together, Jordan and his colleagues designed the first version of the clinic software.

0 comments on commit afeed4e

Please sign in to comment.
Something went wrong with that request. Please try again.