Skip to content

Commit

Permalink
Markdown files updated
Browse files Browse the repository at this point in the history
  • Loading branch information
vmagnin committed Feb 25, 2024
1 parent e7f1ebc commit b4c3a77
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 4 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ All notable changes to the gtk-fortran project are documented in this file. The

### Added
* A FORD documentation with a CI workflow, generating https://vmagnin.github.io/forcolormap/
* A fpm workflow for testing.
* Methods `create_lagrange()` and `create_bezier()` in `src/colormap_class.f90` to create a colormap from continuous interpolation of control colors.
* `example/create.f90` demonstrates creating a custom colormap using methods like `create_lagrange()` and `create_bezier()`.
* A `reverse()` method to reverse a colormap.
* A `shift()` method to apply a circular shift to a colormap (left is +, right is -).
* `example/modify.f90` demonstrates how you can modify a colormap with methods like shift(), in concrete cases.
* A private `check()` method in the Colormap class. It checks the validity of the colormap and its parameters, prints warnings, and fixes problems if necessary.
* A `colormaps_list/ForColormap.pdf` manual listing all the available colormaps.
* `example/colormaps_list.f90` is creating the `colormaps_list/COLORMAPS_LIST_*.md` files using the `Colormaps_info` class.
* A link toward the page *ForColormap Collection Categories* was added in the `README.md` to help users choose a colormap.
* A GitHub workflow for the CMake build by @jchristopherson.
* CMake support by @jchristopherson.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ call setpixelrgb(x, y, red, green, blue)

The library is using the precision `wp=>real64` defined in the module `iso_fortran_env`. And depending on the integers expected by your graphical library, you may need to convert the kinds of red, green, blue variables by writing for example `int(red, kind=int16)` if you need 16 bit integers.

This [guideline](https://s-ink.org/colour-map-guideline) can help you choose the right kind of colormap. And you can visually choose the available colormaps in the `colormaps_list/ForColormap.pdf` manual or on this page (under development): https://github.com/gha3mi/forcolormap/tree/dev
This [guideline](https://s-ink.org/colour-map-guideline) can help you choose the right kind of colormap. And you can visually choose the available colormaps in the [colormaps_list/ForColormap.pdf](https://github.com/vmagnin/forcolormap/blob/main/colormaps_list/ForColormap.pdf) manual or on this page (under development): https://github.com/gha3mi/forcolormap/tree/dev


## Installation
Expand Down
4 changes: 2 additions & 2 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The main goal of v0.9 is to offer a usable library, sufficiently friendly, with

### Features

- [ ] Methods
- [x] Methods
- [x] Implement a `check()` method to fix colormap parameters if needed.
- [x] Include a few minimalist methods to create or manipulate colormaps. More will be added in subsequent releases.
- [ ] Add facilities to pass 8 or 16-bit integers to C graphical libraries.
Expand All @@ -31,7 +31,7 @@ The main goal of v0.9 is to offer a usable library, sufficiently friendly, with

### Continuous Integration (CI)

- [ ] Integrate fpm tests.
- [x] Integrate fpm tests.
- [x] Integrate FORD documentation.

### Building System
Expand Down
1 change: 1 addition & 0 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ They can be launched with the command `fpm run --example name_of_the_example` (w
* `extract.f90` demonstrates how to create a specific colormap by extracting a specified number of colors of a colormap.
* `info.f90` demonstrates how to obtain information about a colormap using the `Colormaps_info` class.
* `modify.f90` demonstrates how you can modify a colormap with methods like shift(), in concrete cases.
* `colormaps_list.f90` is creating the `colormaps_list/COLORMAPS_LIST_*.md` files using the `Colormaps_info` class.
2 changes: 1 addition & 1 deletion logo/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Proposal for forcolormap logo: The logo is inspired by a marble. Two color options are presented for the Crameri Roma color map: 8 levels and 12 levels.
The logo is inspired by a marble. Two color options are presented for the Crameri Roma color map: 8 levels and 12 levels.

These files are under [license CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).

0 comments on commit b4c3a77

Please sign in to comment.