]> Softwares of Agnibho - obscalc.git/blobdiff - README.txt
Enabled extra.js
[obscalc.git] / README.txt
index 8523cb25e4d2cb7d3bf33d414c1366248bf29c20..bcaaf3b69e56926e4f4a69e0d4f185e24325bb8a 100644 (file)
@@ -5,29 +5,40 @@ What is ObsCalc?
 -------------------
 
 ObsCalc is a web application for making some calculations important in
-the practice of Obstetrics. It calculates L.M.P. and E.D.D. based
-Naegle's rule and also calculates maturation of fetus by date and by U.S.G.
+the practice of Obstetrics. It calculates L.M.P. and E.D.D. based on
+Naegle's rule and also calculates maturation of fetus by date and by
+U.S.G.
 
 ObsCalc is written in Javascript.
 
 Downloading
 -----------
 
-Latest release of ObsCalc can be downloaded from https://code.agnibho.com/obscalc/
+Latest release of ObsCalc can be downloaded from
+https://code.agnibho.com/obscalc/
 
 The source code is available at https://github.com/agnibho/obscalc/
 
-
 Usage
 -----
 
-ObsCalc can be used directly after downloading the package and
-decompressing it to a folder.
+ObsCalc needs to be compiled before in can be used. You need Node.js
+and npm installed in your system to compile ObsCalc.
+
+After downloading and decompressing the package, enter the package
+directory and issue the following commands:
+
+npm install
+npm run build
 
-The index.html file can be opened with a modern browser and the
-application can be used right away.
+Now you can use the app by opening the index.html file in any modern
+web browser.
 
-The interface of the application is self-explanatory.
+Alternatively you can run a development version of the app by issuing-
+
+npm run dev
+
+The interface of the application is designed to be self-explanatory.
 
 A hosted version of Obscalc is available at
 https://app.agnibho.com/obscalc/
@@ -40,45 +51,19 @@ All rights reserved
 
 This file is part of ObsCalc.
 
-ObsCalc 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.
+ObsCalc 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.
 
-ObsCalc 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.
+ObsCalc 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 ObsCalc.  If not, see <http://www.gnu.org/licenses/>.
 
-ObsCalc uses the following libraries which are included with ObsCalc
-for convenience. Usage of these libraries are subject to their
-respective licenses.
-
-* Vue.js v2.0.5
-  (c) 2014-2016 Evan You
-  Released under the MIT License.
-
-* jQuery v2.1.1
-  (c) 2005, 2014 jQuery Foundation, Inc.
-  jquery.org/license
-
-* Bootstrap v3.3.7 (http://getbootstrap.com)
-  Copyright 2011-2016 Twitter, Inc.
-  Licensed under the MIT license
-
-* jQuery UI - v1.12.1 - 2016-10-09
-  http://jqueryui.com
-  Copyright jQuery Foundation and other contributors; Licensed MIT
-  
-* moment.js
-  version : 2.15.1
-  authors : Tim Wood, Iskren Chernev, Moment.js contributors
-  license : MIT
-  momentjs.com
-
 Contacts
 --------