README.txt

   1                         DietSurvey
   2                         ==========
   3
   4 What is DietSurvey?
   5 -------------------
   6
   7 DietSurvey is a web application for calculating nutritional intake and comparing
   8 it against the recommended dietary allowances of the members of a family.
   9
  10 DietSurvey is written in Javascript.
  11
  12 Downloading
  13 -----------
  14
  15 Latest release of DietSurvey can be downloaded from
  16 https://code.agnibho.com/dietsurvey/
  17
  18 The source code is available at https://github.com/agnibho/dietsurvey/
  19
  20 Usage
  21 -----
  22
  23 DietSurvey needs to be compiled before in can be used. You need Node.js
  24 and npm installed in your system to compile DietSurvey.
  25
  26 After downloading and decompressing the package, enter the package
  27 directory and issue the following commands:
  28
  29 npm install
  30 npm run build
  31
  32 Now you can use the app by opening the index.html file in any modern
  33 web browser.
  34
  35 Alternatively you can run a development version of the app by issuing-
  36
  37 npm run dev
  38
  39 The interface of the application is designed to be self-explanatory.
  40
  41 A hosted version of Obscalc is available at
  42 https://app.agnibho.com/dietsurvey/
  43
  44 Licensing
  45 ---------
  46
  47 Copyright (c) 2017 Agnibho Mondal
  48 All rights reserved
  49
  50 This file is part of DietSurvey.
  51
  52 DietSurvey is free software: you can redistribute it and/or modify it
  53 under the terms of the GNU General Public License as published by the
  54 Free Software Foundation, either version 3 of the License, or (at your
  55 option) any later version.
  56
  57 DietSurvey is distributed in the hope that it will be useful, but WITHOUT
  58 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  59 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  60 for more details.
  61
  62 You should have received a copy of the GNU General Public License
  63 along with DietSurvey.  If not, see <http://www.gnu.org/licenses/>.
  64
  65 Contacts
  66 --------
  67
  68 Agnibho Mondal
  69 mondal@agnibho.com
  70 www.agnibho.com