Added a README.md file in each subdirectory

CHANGELOG.md

@@ -4,6 +4,7 @@ All notable changes to the gtk-fortran project are documented in this file. The
 ## [forcolormap dev]
 
 ### Added
+* A `README.md` file in each subdirectory describing the files inside.
 * The discrete colormaps of the *Scientific Colour Maps* collection, thanks to the `scripts/gpl_to_lut.f90` program.
 * A `reverse` boolean option was added to the methods `set`, `create`, and `load` to reverse a colormap.
  * An `example/demo_reverse.f90` example.

example/README.md

@@ -0,0 +1,7 @@
+# Examples
+
+They can be launched with the command `fpm run --example name_of_the_example` (without the `.f90` extension):
+
+* `demo.f90` creates demo PPM files for each built-in colormap, plus a PPM file with the corresponding colorbars. It also demonstrates how to create your own colormap defined in an array and how to download a colormap from a `.txt` file.
+* `demo_reverse.f90` demonstrates the usage of the `reverse=.true.` option to reverse the direction of a colormap.
+* `example1.f90` demonstrates how ForImage can be used to import/export PPM files.

scripts/README.md

@@ -0,0 +1,8 @@
+# Scripts
+
+These programs are used to generate Fortran code for specific colormaps, like the *Scientific Colour Maps* collection:
+
+* `gpl_to_lut.f90` converts `.gpl` files in the Scientific Colour Map collection and its subdirectories to `.lut` files. Used for discrete colormaps.
+* `generate_scmap.f90` generates this two files:
+ * `scientific_colour_maps.f90` from the `.lut` files of the *Scientific Colour Maps* collection. It must then be copied to `../src`.
+ * `copy-paste_code.f90`: its code must be copied/pasted in the `src/colormap_class.f90` file, in the `select case(self%name)` statement.

src/README.md

@@ -0,0 +1,8 @@
+# Library source code
+
+* `colormap_class.f90`: the Colormap class and the `colormaps_list`.
+* `colormap_parameters.f90`: a few parameters used in several modules of the library.
+* The modules containing the different collections of colormaps:
+ * `scientific_colour_maps.f90`
+ * `matplotlib_colormaps.f90`
+ * `miscellaneous_colormaps.f90`

test/README.md

@@ -0,0 +1,3 @@
+# Automatic tests
+
+* `check.f90`: a few tests to launch with the command `fpm test`. It will print nothing if everything runs well.