Merge pull request #272 from njoy/update/website

Update/website

CMakeLists.txt

@@ -1,5 +1,5 @@
 
-cmake_minimum_required( VERSION 3.2 )
+cmake_minimum_required( VERSION 3.15 )
 
 find_package( Python3 3.5 REQUIRED )
 

README.md

@@ -2,17 +2,52 @@
 
 # NJOY2016
 
- The NJOY Nuclear Data Processing System is a modular computer code designed to read evaluated data in ENDF format, transform the data in various ways, and output the results as libraries designed to be used in various applications. Each module performs a well defined processing task. The modules are essentially independent programs, and they communicate with each other using input and output files, plus a very few common variables.
+The NJOY Nuclear Data Processing System is a modular computer code designed to read evaluated data in ENDF format, transform the data in various ways, and output the results as libraries designed to be used in various applications. Each module performs a well defined processing task. The modules are essentially independent programs, and they communicate with each other using input and output files, plus a very few common variables.
 
 ## Documentation
-The documentation for NJOY2016 is found in the [NJOY2016-manual](https://github.com/njoy/NJOY2016-manual) repository. There, you can find a [pre-compiled PDF](https://github.com/njoy/NJOY2016-manual/raw/master/njoy16.pdf) of the manual.
+The user manual for NJOY2016 can be found here: [NJOY User Manual (pdf)](https://github.com/njoy/NJOY2016-manual/raw/master/njoy16.pdf).
 
-Please refer to the [Release Notes](ReleaseNotes.md) to see what has changed from one version to the next.
+## Release and development versions
+For the latest version of NJOY2016 and an overview of the latest changes, please see the [Release Notes](ReleaseNotes.md) or the [release](https://github.com/njoy/NJOY2016/releases) page.
+
+The latest release version of NJOY2016 can always be found at the head of the [main](https://github.com/njoy/NJOY2016) branch of this repository and every release is associated to a release tag. New versions are released on a regular basis (we aim to provide updates at least every three months). The latest development version of NJOY2016 containing the latest updates and changes can be found in at the head of the [develop](https://github.com/njoy/NJOY2016/tree/develop) branch. This development version should be used with caution.
 
 ## Installation
-Instructions for the installation of NJOY2016 are found on our page, [Obtaining and Installing NJOY](https://docs.njoy21.io/install.html).
 
-## Modules
+### Prerequisites:
+
+The following are the prerequisites for compiling NJOY2016:
+  - git
+  - cmake 3.15 or higher
+  - a Fortran 2003 compliant compiler such as gcc-7 or higher
+
+Note: gcc-11.3 has been known to produce an internal compiler error while compiling NJOY2016, so as a result this specific version of gcc is not supported. Other versions of gcc (version 7 or higher) seem to be capable of compiling NJOY2016.
+
+### Instructions:
+
+To compile the latest NJOY2016 version, you can use the following instructions:
+```
+git clone https://github.com/njoy/NJOY2016.git
+cd NJOY2016
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release ../
+make -j8
+```
+
+The above instructions will produce a release build consisting of a dynamic library and dynamically linked executable. To compile a static version (i.e. the executable is not a dynamically linked executable), the cmake command shown above should be replaced with the following cmake command:
+```
+cmake -DCMAKE_BUILD_TYPE=Release -Dstatic_libraries=ON
+      -Dstatic_njoy=ON -DCMAKE_EXE_LINKER_FLAGS=-static ../
+```
+
+When you have already cloned the NJOY2016 repository and wish to update to the latest version, you can use the following instructions (inside the build folder):
+```
+git pull
+make -j8
+```
+
+## Module overview
 +  `NJOY` directs the flow of data through the other modules and contains a library of common functions and subroutines used by the other modules.
 +  `RECONR` reconstructs pointwise (energy-dependent) cross sections from ENDF resonance parameters and interpolation schemes.
 +  `BROADR` Doppler broadens and thins pointwise cross sections.