Merge pull request #13 from huerlisi/chore/doc-updates

Documentation updates

INSTALL.md

@@ -0,0 +1,77 @@
+We currently support installing on Debian 5.0 Lenny and Ubuntu 12.04
+systems.
+
+Install Ruby’n’Rails
+--------------------
+
+CyDoc is developed and tested using Rails 3.2 and Ruby 1.9.
+
+Install packages to needed:
+
+    sudo apt-get install rubygems irb recode sqlite3 libsqlite3-dev libmysqlclient-dev libxml2-dev libxslt-dev cups-bsd cups-client libcups2-dev ruby-dev build-essential
+    sudo apt-get install git
+    sudo apt-get install sphinxsearch
+
+Then some gems:
+
+    sudo gem install rake bundler
+
+Install fonts for PDF generator
+-------------------------------
+
+The font DejaVuSans and DejaVuSans-Bold is used by the PDF generator.
+
+### Debian systems
+
+    sudo apt-get install ttf-dejavu
+
+### Other \*nix systems
+
+Create the folder and place the files there.
+The names of these font files should be “DejaVuSans.ttf” and
+“DejaVuSans-Bold.ttf”.
+
+    sudo mkdir -p /usr/share/fonts/truetype/ttf-dejavu/
+
+Install CyDoc
+-------------
+
+Install current CyDoc from git repostory. We’ll use this checkout as
+working directory from now on:
+
+    sudo git clone http://github.com/huerlisi/CyDoc.git
+    cd CyDoc
+
+Install dependency gems:
+
+    bundle
+
+Setup database:
+
+Copy database.yml.example to database.yml and edit as needed\
+sudo cp config/database.yml.example config/database.yml
+
+    cp config/database.yml.example config/database.yml
+
+Initialize the database:
+
+    bundle exec rake db:setup
+
+Inititalize the sphinx freetext search index:
+
+    bundle exec rake ts:rebuild
+
+An initial tenant and user has been created for you. Please change your
+password as soon as possible.
+
+### Run
+
+You should now be able to start CyDoc:
+
+    bundle exec rails server
+
+CyDoc is now available at http://localhost:3000
+
+You can login with username ‘doctor’ and password ‘doctor1234’.
+
+Enjoy!

README.md

@@ -0,0 +1,89 @@
+CyDoc
+=====
+
+CyDoc is a webbased Doctors Office Application. It allows you to track
+your patients medical history and handles all your billing needs.
+
+Features
+--------
+
+-   Patient relationship management
+    -   Register new patients
+    -   Update patients information
+    -   Show medical history
+    -   Recall management
+-   Medical histroy tracking
+    -   Free Text diary
+-   Tariff Support
+    -   Tarmed Swiss
+    -   Drug tariff
+    -   Laboratory tariff
+    -   Custom and pre-defined Tariff groups
+-   Invoicing
+    -   Partial invoice support
+    -   Paper invoices
+    -   Multiple reminder states
+    -   Payment booking by ESR
+-   Bookkeeping
+    -   Double entry accounting
+
+Usage
+-----
+
+CyDoc is available as Software as a Service. This means that all the
+maintenance task to run CyDoc are outsourced. You only need web access
+using a modern web-browser. All traffic is encrypted and your valuable
+data is backed up routinely.
+
+We try stick with the slogan ‘Keep it simple, stupid’. The interface
+follows modern industrial design rules. All pages try to give you just
+enough information to do the task while being simple. Dynamic elements
+such as inline editing are used sparsely, but are there where
+appreciated.
+
+Feedback
+--------
+
+CyDoc is not the average Medical Desktop Application. It is built using
+the same technologies and principles as well known internet services
+like Facebook, tel.search.ch or GMX. This allows very fast development
+and roll-out times. Every feedback, both positive and negative is very
+much appreciated.
+
+Documentation
+-------------
+
+-   [Installation](https://github.com/huerlisi/CyDoc/blob/master/INSTALL.textile)
+
+Contributing
+------------
+
+Code is available at [github](http://github.com/huerlisi/CyDoc).
+
+Issue tracking is done using
+[Redmine](http://redmine.cyt.ch/projects/CyDoc/issues).
+
+License
+-------
+
+Copyright 2007-2013 Simon Hürlimann <simon.huerlimann@cyt.ch>
+Copyright 2012-2013 Andi Staub <andi.staub@cyt.ch>
+Copyright 2010-2012 Ramon Egloff <ramon.egloff@cyt.ch>
+Copyright 2010-2012 Roman Simecek <roman.simecek@cyt.ch>
+Copyright 2010 David Hürlimann <david.huerlimann@cyt.ch>
+Copyright 2007-2012 CyT <info@cyt.ch>
+Copyright 2007-2012 ZytoLabor <info@zyto-labor.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+