Rewritten in PHP/Javascript

[dietsurvey.git] / README.txt

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..8a4a672
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,80 @@
+                        Diet-Survey
+                       ===========
+
+What is Diet-Survey?
+-------------------
+
+Diet-Survey is a web application for calculating nutrient intake of a
+family based on their food consumption in last 24 hours.
+
+Diet-Survey is written in PHP and Javascript for server installation.
+
+Downloading
+-----------
+
+Latest release of Diet-Survey can be downloaded from http://code.agnibho.com/dietsurvey/
+
+The source code is available at https://github.com/agnibho/dietsurvey/
+
+Installation
+------------
+
+Please see the file named INSTALL.txt for installation instructions.
+
+Usage
+-----
+
+After installation Diet-Survey can be accessed from the designated
+URL.
+
+You need to enter some health information about the family members and
+the list and amount of food they have consumed in the last 24 hours.
+
+A hosted version of Diet-Survey is available at
+http://dietsurvey.agnibho.com/
+
+Licensing
+---------
+
+Copyright (c) 2013-2015 Agnibho Mondal
+All rights reserved
+
+This file is part of Diet-Survey.
+
+Diet-Survey is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Diet-Survey 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Diet-Survey.  If not, see <http://www.gnu.org/licenses/>.
+
+Diet-Survey uses the following libraries which are included with Diet-Survey
+for convenience. Usage of these libraries are subject to their
+respective licenses.
+
+* jQuery v1.11.3
+  (c) 2005, 2015 jQuery Foundation, Inc.
+  jquery.org/license
+  
+* Bootstrap v3.3.6 (http://getbootstrap.com)
+  Copyright 2011-2015 Twitter, Inc.
+  Licensed under MIT
+  (https://github.com/twbs/bootstrap/blob/master/LICENSE)
+
+* Chart.js v1.0.1-beta.4 (http://chartjs.org/)
+  Copyright 2014 Nick Downie
+  Released under the MIT license
+  https://github.com/nnnick/Chart.js/blob/master/LICENSE.md
+
+Contacts
+--------
+
+Agnibho Mondal
+mail@agnibho.com
+www.agnibho.com