Skip to content

Commit

Permalink
ROADMAP.md and README.md updated
Browse files Browse the repository at this point in the history
  • Loading branch information
vmagnin committed Mar 11, 2024
1 parent d7a3684 commit 93cb28c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ forcolormap = {git = "https://github.com/vmagnin/forcolormap.git"}
### Using CMake

You can also build the project with CMake:

```bash
$ git clone git@github.com:vmagnin/forcolormap.git
$ cd forcolormap
Expand All @@ -76,18 +77,21 @@ $ sudo make install

#### Static linking
By default, ForColormap is built as a static library by CMake. You can compile your program with the `-static` option:

```bash
$ gfortran -static my_program.f90 $(pkg-config --cflags --libs forcolormap forimage)
```
Note that ForColormap is depending on ForImage, and for static linking you must respect that order.

#### Dynamic linking
There is a CMake option to obtain a shared library:

```bash
$ cmake -D BUILD_SHARED_LIBS=true ..
```

You can compile your program like this:

```bash
$ gfortran my_program.f90 $(pkg-config --cflags --libs forcolormap)
```
Expand All @@ -100,13 +104,15 @@ $ export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/
#### Building examples and tests

You can build the examples with:

```bash
$ cmake -D BUILD_FORCOLORMAP_EXAMPLES=true ..
$ make
$ cd example
```

The automatic tests can be run with:

```bash
$ cmake -D BUILD_TESTING=true ..
$ make
Expand All @@ -116,6 +122,7 @@ $ ctest
#### Uninstalling ForColormap

From the `build` directory:

```bash
$ sudo make uninstall_forcolormap
```
Expand Down
6 changes: 3 additions & 3 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ The main goal of v0.9 is to offer a usable library, sufficiently friendly, with
- [x] Develop a PDF guide with all colorbars to aid in choosing a colormap.
- [x] Develop a web version guide with all colorbars to aid in choosing a colormap.
- [x] Create a simple documentation generated with FORD.
- [x] Include real simulation images (`gallery/` directory).

### Continuous Integration (CI)

Expand All @@ -36,11 +37,11 @@ The main goal of v0.9 is to offer a usable library, sufficiently friendly, with

### Building System

- [x] Test with a gtk-fortran fpm project.
- [x] Test with a gtk-fortran fpm project: Linux, FreeBSD, macOS, MSYS2/Windows.
- [x] Implement a CMake building system, allowing installation of a `.so`
- [x] Test on Linux.
- [x] Test on FreeBSD.
- [ ] Test on Windows (MSYS2).
- [ ] Test on Windows (MSYS2): issue [#37](https://github.com/vmagnin/forcolormap/issues/37)
- [x] Test on macOS.

### Others
Expand Down Expand Up @@ -116,7 +117,6 @@ These concepts are open for implementation or consideration. They may or may not
### Documentation

- [ ] Include a few images in the `README.md` file.
- [ ] Include real simulation images.

### Publication

Expand Down

0 comments on commit 93cb28c

Please sign in to comment.