README.txt

   1                         Equsol
   2                         ======
   3
   4 What is Equsol?
   5 -------------------
   6
   7 Equsol is a shell script for solving equations in the command line. The
   8 equations are stored in a plain text file and can be easily added / modified /
   9 removed depending on the user's preferences.
  10
  11 Equsol is written in bash script.
  12
  13 Downloading
  14 -----------
  15
  16 Latest release of Equsol can be downloaded from http://code.agnibho.com/equsol/
  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
  25 equation 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 Equsol can be used from bash command line.
  34
  35 Run equsol without any arguments to see a list of available equations.
  36
  37 You can run equsol with the name of an equation file as argument to solve it.
  38
  39 If the file contains multiple equations you will receive the option to choose
  40 which equation to solve.
  41
  42 After selecting the equation equsol will run the equation and ask for your input
  43 for different variables required in the equation. After entering the values
  44 equsol will run the calculations and print the result in the screen.
  45
  46 The equation files are placed in the data folder. The files can contain one
  47 equation per line. Empty lines are ignored.
  48
  49 While writing equations variables are written within square brackets. Some
  50 examples are available within the downloaded data folder. The lines starting
  51 with # are treated as comments.
  52
  53 Licensing
  54 ---------
  55
  56 Copyright (c) 2017 Agnibho Mondal
  57 All rights reserved
  58
  59 This file is part of Equsol.
  60
  61 Equsol is free software: you can redistribute it and/or modify it under the
  62 terms of the GNU General Public License as published by the Free Software
  63 Foundation, either version 3 of the License, or (at your option) any later
  64 version.
  65
  66 Equsol is distributed in the hope that it will be useful, but WITHOUT ANY
  67 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  68 PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  69
  70 You should have received a copy of the GNU General Public License along with
  71 Equsol.  If not, see <http://www.gnu.org/licenses/>.
  72
  73 Contacts
  74 --------
  75
  76 Agnibho Mondal
  77 contact@agnibho.com
  78 www.agnibho.com