Skip to content

Commit 8a91e19

Browse files
author
Damian Rouson
authored
Merge pull request #39 from sourceryinstitute/udpate-readme
Update README.md to reflect changes since forking
2 parents 01da95e + cd68a83 commit 8a91e19

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
Overview
22
========
33

4-
DAG is a Fortran 2018 library for creating and manipulating directed acyclic graphs (DAGs).
5-
It includes a topological sort feature, and it generates files in the [GraphViz] "dot" format.
4+
DAG is a Fortran 2018 library for creating and manipulating directed acyclic graphs (DAGs). DAG is based on a fork of [daglib by Jacob Williams], refactored to add
5+
6+
* A build system and test harness automated by [fpm],
7+
* Unit testing written with [Vegetables],
8+
* Continuous-integration testing and documentation deployment via [GitHub Actions],
9+
* Documentation generated by [FORD],
10+
* Runtime assertion-checking using [Sourcery], and
11+
* [JSON] file input/output using [jsonff].
12+
13+
DAG includes a topological sort feature, and it generates files in the [GraphViz] "dot" format.
614

715
Prerequisites
816
-------------
@@ -17,22 +25,18 @@ Earlier versions might work also.
1725

1826
Building and testing
1927
--------------------
20-
To clone, build, and test, execute the following in a `bash` shell:
28+
After installing [fpm], clone, build, and test, execute the following in a `bash`-like shell:
2129
```
2230
git clone git@github.com:sourceryinstitute/dag
2331
fpm test --compiler caf --runner "cafrun -n 1"
2432
```
2533
replacing `1` in the last line with the desired number of images to execute in parallel for
2634
each test. Please report any test failures by submitting an [issue] on the DAG repository.
2735

28-
Users who prefer a [FoBiS] build system, please see [daglib by Jacob Williams],
29-
from which the current repository was forked.
30-
3136
Example
3237
-------
3338

3439
The [jacob-example] test provides a short example of the use of dag, including checks
35-
3640
for the expected results. That test also writes the following image to a `.pdf` file:
3741

3842
<img src="https://user-images.githubusercontent.com/13108868/99005591-f0c59480-24f5-11eb-96a3-c5416f197360.png" width="500">
@@ -43,12 +47,18 @@ License
4347
This library is released under a [BSD-3 license].
4448

4549
[daglib by Jacob Williams]: https://github.com/jacobwilliams/daglib
46-
[FoBiS]: https://github.com/szaghi/FoBiS
4750
[GraphViz]: https://www.graphviz.org
4851
[jacob-example]: https://github.com/sourceryinstitute/dag/blob/master/tests/integration/jacob-example/test-jacob-example.f90
4952
[OpenCoarrays]: https://github.com/sourceryinstitute/opencoarrays
5053
[CMake]: https://www.cmake.org
5154
[gfortran]: https://gcc.gnu.org
5255
[BSD-3 license]: https://github.com/sourceryinstitute/dag/blob/master/LICENSE
53-
[fpm]: https://github.com/everythingfunctional/fpm
56+
[fpm]: https://github.com/fortran-lang/fpm
5457
[3276af]: https://github.com/everythingfunctional/fpm/commit/3276af2e000d1b2c90f151148cd01cce0d3e886d
58+
59+
[Vegetables]: https://gitlab.com/everythingfunctional/Vegetables
60+
[GitHub Actions]: https://github.com/features/actions
61+
[FORD]: https://github.com/Fortran-FOSS-Programmers/ford
62+
[Sourcery]: https://github.com/Fortran-FOSS-Programmers/ford
63+
[JSON]: https://www.json.org/json-en.html
64+
[jsonff]: https://gitlab.com/everythingfunctional/jsonff

0 commit comments

Comments
 (0)