Skip to content

License + README tweaks #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rouson merged 2 commits into from
Jan 17, 2026
Merged

License + README tweaks #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a3ab3d
Add license header
bonachea Jan 17, 2026
75bd683
README: light copy-editing
bonachea Jan 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions LICENSE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
***********************************
*** Formal Terms and Conditions ***
***********************************

All files in this directory and all sub-directories (except where otherwise
noted) are subject to the following copyright and licensing terms:


****************************

*** Copyright Notice ***
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ _Towards a formally verifiable, tensor-calculus langauge embedded in Fortran 202

## Examples
See this repository's [example](./example) subdirectory for demonstrations of how
to use Formal. For usage information for each example, execute something like
to use Formal. For usage information for each example, execute something like:
```bash
fpm run --example <base-name> -- --help
```
Expand All @@ -24,10 +24,10 @@ directory as your present working directory before issuing the above `fpm run`
command. Then use tab completion to enter enter the base name and delete the
file extension before pressing `return`.

## Prereqisite
## Prerequisites

Building and testing Formal requires the Fortran Package Manager ([`fpm`]),
which can be obtained via package manager (e.g., `brew install fpm` on macOS)
which can be obtained via a package manager (e.g., `brew install fpm` on macOS)
or by compiling the single-file concatenation of the `fpm` source that is
included among the release assets. For the `fpm` 0.12.0 release, for example,
compiling [fpm-0.12.0.F90] and placing the resulting executable file in your
Expand All @@ -46,7 +46,7 @@ compiling [fpm-0.12.0.F90] and placing the resulting executable file in your

**Known Issues**
1. With `fpm` versions _after_ 0.12.0, `flang-new` can be shortened to `flang`.
2. With NAG 7.2, Build 7235 or later is recommmend, but earlier builds might work.
2. With NAG 7.2, Build 7235 or later is recommended, but earlier builds might work.

## Documentation
The [`doc/uml/class-diagram.md`] file contains a Mermaid script that generates a
Expand Down