source: README.txt

Last change on this file was 475afd6, checked in by Agnibho Mondal <mondal@…>, 3 years ago

Rewritten in Javascript for offline use

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