README.txt

   1                         Mscore
   2                         ======
   3
   4 What is Mscore?
   5 -------------------
   6
   7 Mscore is a shell script for calculating medical scores in the command line. The
   8 score informations are stored in a plain text file and can be easily added /
   9 modified / removed depending on the user's preferences.
  10
  11 Mscore is written in bash script.
  12
  13 Downloading
  14 -----------
  15
  16 Latest release of Mscore can be downloaded from http://code.agnibho.com/mscore/
  17
  18 Installation
  19 ------------
  20
  21 1. Download the script and place it in your path. Alternatively you can place it
  22 anywhere and create an alias instead.
  23
  24 2. Download the data folder which also contains some working examples of medical
  25 score files.
  26
  27 3. Edit the main script and update the DIR variable to contain the path to your
  28 downloaded data folder.
  29
  30 Usage
  31 -----
  32
  33 Mscore can be used from bash command line.
  34
  35 Run mscore without any arguments to see a list of available scores.
  36
  37 You can run mscore with the name of an score file as argument to calculate it.
  38
  39 After selecting the score mscore will run the score file and ask for your input
  40 for different variables required in the calculation. After entering the values
  41 mscore will run the calculation and print the result in the screen.
  42
  43 The score files are placed in the data folder. Empty lines are ignored. The
  44 lines starting with # are treated as comments.
  45
  46 Some examples are available within the downloaded data folder.
  47
  48 Licensing
  49 ---------
  50
  51 Copyright (c) 2017 Agnibho Mondal
  52 All rights reserved
  53
  54 This file is part of Mscore.
  55
  56 Mscore is free software: you can redistribute it and/or modify it under the
  57 terms of the GNU General Public License as published by the Free Software
  58 Foundation, either version 3 of the License, or (at your option) any later
  59 version.
  60
  61 Mscore is distributed in the hope that it will be useful, but WITHOUT ANY
  62 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  63 PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  64
  65 You should have received a copy of the GNU General Public License along with
  66 Mscore.  If not, see <http://www.gnu.org/licenses/>.
  67
  68 Contacts
  69 --------
  70
  71 Agnibho Mondal
  72 contact@agnibho.com
  73 www.agnibho.com