README file update

README

@@ -1,61 +0,0 @@
-This package is provided as a companion to the papers
-
-  Transport policies in polycentric cities, by
-  Q. David et M. Kilani, 2019.
-
-The package is composed of two executables :
-
-- scbd    : fixed frequencies
-- f_scbd  : endogenous frequencies
-
-The optimization step relies on the packages BOBYQA
-and COBYLA written by Pr. Powell (the double precision 
-versions are used).
-
-The file "scbd.dat" is read for model parameters.
-
-The source code is located in the "src" subdirectory.
-The subroutines are separated into several files.
-The EQUILIBRIUM subroutine is central since it is the 
-one where the network equilibrium is computed.
-
-
-INSTALLATION (unix like systems)
-================================
-
-0. For a unix-like system (for Windows
-   the process should be similar)
-   We assume that gfortran (or an equivalent)
-   is installed.  
-
-1. Unzip the file "scbd.zip"
-
-2. Change to the directory root of that uncompressed folder.
-
-3. Type "make" (gfortran should be installed)
-   "scbd" and "f_scbd" executables are produced
-
-4. Edit "scbd.dat" file and save
-
-5. Type "./scbd" 
-   The output is written to the screen.
-   Standard redirection can be used to save output
-   to file.
-
-
-REMARK
-======
-
-For some parameter values the obtained output may not 
-be optimal because the trust region search is 
-not convenient. In case of doubt, it is preferable to
-change the values of parameters "RHOBEG" and "RHOEND" 
-and check for robustness. Too small values may miss the
-exploration of the optimal region and values that are 
-too large are likely to yield instability and non 
-convergence. The given values should work well 
-if the values of the model parameters are are not 
-changed so much.
-
-
-

README.md

@@ -1,3 +1,60 @@
-# scbd
+## Overview
+
+This package is provided as a companion to the papers
+
+  Transport policies in polycentric cities, by
+  Q. David et M. Kilani, 2019.
+
+The package is composed of two executables :
+
+- scbd    : fixed frequencies
+- f_scbd  : endogenous frequencies
+
+The optimization step relies on the packages BOBYQA
+and COBYLA written by Pr. Powell (the double precision 
+versions are used).
+
+The file "scbd.dat" is read for model parameters.
+
+The source code is located in the "src" subdirectory.
+The subroutines are separated into several files.
+The EQUILIBRIUM subroutine is central since it is the 
+one where the network equilibrium is computed.
+
+
+## INSTALLATION 
+
+0. For a unix-like system (for Windows
+   the process should be similar)
+   We assume that gfortran (or an equivalent)
+   is installed.  
+
+1. Clone this directory 
+    git clone https://gogs.univ-littoral.fr/mkilani/scbd
+
+2. Type "make" (gfortran should be installed)
+   "scbd" and "f_scbd" executables are produced
+
+4. Edit "scbd.dat" file and save
+
+5. Type "./scbd" 
+   The output is written to the screen.
+   Standard redirection can be used to save output
+   to file.
+
+
+## REMARK
+
+For some parameter values the obtained output may not 
+be optimal because the trust region search is 
+not convenient. In case of doubt, it is preferable to
+change the values of parameters "RHOBEG" and "RHOEND" 
+and check for robustness. Too small values may miss the
+exploration of the optimal region and values that are 
+too large are likely to yield instability and non 
+convergence. The given values should work well 
+if the values of the model parameters are are not 
+changed so much.
+
+
 
-Code source pour le papier avec Quentin