Final checks (#20)

* Format license file

* Flex library name

* Edits to readme file

LICENSE

@@ -1,12 +1,12 @@
-            GNU GENERAL PUBLIC LICENSE
-               Version 2, June 1991
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-                       59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
-                Preamble
+                            Preamble
 
   The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
@@ -56,7 +56,7 @@ patent must be licensed for everyone's free use or not licensed at all.
   The precise terms and conditions for copying, distribution and
 modification follow.
 
-            GNU GENERAL PUBLIC LICENSE
+                    GNU GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
   0. This License applies to any program or other work which contains
@@ -255,7 +255,7 @@ make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 
-                NO WARRANTY
+                            NO WARRANTY
 
   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
@@ -277,4 +277,4 @@ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
-             END OF TERMS AND CONDITIONS
+                     END OF TERMS AND CONDITIONS

Makefile.defs

@@ -32,16 +32,16 @@
 
 # In order to compile KPP you have to provide the following information:
 
-# 1. The name of the compiler you want to use. Normaly this 
+# 1. The name of the compiler you want to use. Normaly this
 #    is either GNU C compiler (gcc) or the native compiler (cc)
-#    You can use the complete pathname if the compiler is not in $PATH 
+#    You can use the complete pathname if the compiler is not in $PATH
 #    Note that for SUN machines is better to use gcc.
 #    For GNU C compiler use:
 #      CC=gcc
 #    For the native compiler use:
 #      CC=cc
 
-CC=gcc 
+CC=gcc
 
 # 2. The name of your lexical analizer. KPP requires FLEX to be used.
 #    FLEX is a public domain lexical analizer and you can download it from
@@ -50,14 +50,14 @@ CC=gcc
 
 FLEX=flex
 
-# 3. The complete pathname of the FLEX library (libfl.a).
-#    On many systems this is either: 
+# 3. The complete pathname of the FLEX library ("libfl.a" or "libfl.so").
+#    On many systems this is either:
 #    /usr/lib, /usr/lib64, /usr/local/util/lib/flex
 
 FLEX_LIB_DIR=/usr/lib
 
-# 4. Platform independent C compiler flags. By default "-O" is used which 
-#    turns on optimization. If you are experiencing problems you may try 
+# 4. Platform independent C compiler flags. By default "-O" is used which
+#    turns on optimization. If you are experiencing problems you may try
 #    "-g" to include debuging informations.
 
 CC_FLAGS= -g -Wall

README.md

@@ -1,6 +1,6 @@
 # KPP-Mistra
 
-KPP-Mistra is a version of the KPP software customized for the
+KPP-Mistra is a version of the Kinetics PreProcessor (KPP) software customized for the
 [Mistra model](https://github.com/MistraModel/Mistra).
 
 KPP-Mistra should only be used in conjunction with the
@@ -45,71 +45,72 @@ E-mail: sandu@cs.vt.edu
 
 ### Reference
 
-V. Damian, A. Sandu, M. Damian, F. Potra, G.R. Carmichael: "The
-Kinetic PreProcessor KPP -- A Software Environment for Solving
-Chemical Kinetics", Computers and Chemical Engineering, 26, 11,
-1567-1579, 2002 [[link](https://doi.org/10.1016/S0098-1354(02)00128-X)].
+V. Damian, A. Sandu, M. Damian, F. Potra, G.R. Carmichael: "The Kinetic
+PreProcessor KPP - A Software Environment for Solving Chemical Kinetics",
+Computers and Chemical Engineering, 26, 11, 1567-1579, 2002
+[[link](https://doi.org/10.1016/S0098-1354(02)00128-X)].
 
 ******************************************************************************
 
 ## KPP-Mistra
 
-KPP-Mistra was developed from *KPP v2.2.3* and includes all the bugfixes
-and modifications made by R. Sander and J. Bock (see the `f77` and
-`mistra` branches at: https://bitbucket.org/gcst/kpp), plus additional
-modifications specific to Mistra made by J. Bock. A summary of the
-changes can be found in the `CHANGELOG.md` file.
+KPP-Mistra was developed from *KPP v2.2.3* and includes all the bugfixes and
+modifications made by R. Sander and J. Bock (see the `f77` and `mistra` branches
+at: https://bitbucket.org/gcst/kpp), plus additional modifications specific to Mistra
+made by J. Bock. A summary of the changes can be found in the `CHANGELOG.md` file.
 
 The stable version of KPP-Mistra can be downloaded from the
-[Releases](https://github.com/MistraModel/KPP-Mistra/releases)
-page.
+[Releases](https://github.com/MistraModel/KPP-Mistra/releases) page.
 
 ### Instructions
 
 #### To install KPP-Mistra:
 
 1. Check that FLEX (open-source lexical analizer) is installed using
-   the command: `flex --version`
+   the command: `flex --version`.
 
-2. Note the path of the FLEX library (`libfl.a` or `libfl.so`).
+2. Find the path of the FLEX library (`libfl.a` or `libfl.so`) using
+   the command: `locate -b libfl.*`.
 
 3. Check that BISON (open-source parser generator) is installed using
-   the command: `bison --version`
+   the command: `bison --version`.
 
-4. Define the `$KPP_HOME` environment variable to point to the location of KPP-Mistra.
+4. Define the `$KPP_HOME` environment variable to point to the path of KPP-Mistra.
    If, for example, KPP-Mistra is installed in `$HOME/KPP-Mistra`:
 
-  - if using the **C** shell (or **tcsh** shell), add the following to
-    `$HOME/.cshrc` (or `$HOME/.tcshrc`):
+  - if using the **C** shell (or the **tcsh** shell), add the following to
+    `~/.cshrc` (or `~/.tcshrc`):
     ```shell
     setenv KPP_HOME $HOME/KPP-Mistra
-    set path=( $path $KPP_HOME/bin )
+    set PATH=( $PATH $KPP_HOME/bin )
     ```
 
-  - if using the **bash** shell, add the following to `$HOME/.bashrc`:
+  - if using the **bash** shell, add the following to `~/.bashrc`:
     ```shell
     export KPP_HOME=$HOME/KPP-Mistra
-    export PATH=${PATH}:$KPP_HOME/bin
+    export PATH=$PATH:$KPP_HOME/bin
     ```
 
    - Execute the command `source ~/.cshrc` (or `.tcshrc`, or `.bashrc`) to make
-     sure that these changes are in effect. Alternatively, close and reopen the terminal.
+     sure that the changes are in effect. Alternatively, close and reopen the terminal.
+     The command `echo $KPP_HOME` should return the correct path of KPP-Mistra.
 
-5. In `$KPP_HOME` edit the file `Makefile.defs` and follow the instructions to
-   specify the compiler, the location of the FLEX library, etc...
+5. In `$KPP_HOME` edit the `Makefile.defs` file. Follow the
+   instructions to specify the compiler (by default, the GNU compiler
+   `gcc`), the path of the FLEX library, etc...
 
-6. In the `KPP_HOME` directory build the source files using the command: `make`
+6. In `KPP_HOME` build the source files using the `make` command. Check that the
+   installation has been successful using the command `which kpp`.
 
-#### To clean KPP-Mistra:
+#### To clean the KPP-Mistra installation:
 
-1. Delete the KPP object files with the command: `make clean`
+1. Delete the KPP object files with the command: `make clean`.
 
-2. Delete the KPP object files and binaries with the command: `make distclean`
+2. Delete the KPP object files and binaries with the command: `make distclean`.
 
-#### To use KPP-Mistra:
+#### To use KPP-Mistra with the Mistra model:
 
 The *KPP User's Manual* can be found in the `doc/` directory.
 
 Please refer to the *Mistra manual* in the `doc/` directory of the
-[Mistra repository](https://github.com/MistraModel/Mistra) for
-further information.
+[Mistra repository](https://github.com/MistraModel/Mistra) for further information.