Skip to content

Commit

Permalink
modify meta.yml and generate README.md for new building instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
palmskog authored and ybertot committed Nov 14, 2024
1 parent b1a9bfa commit 1739214
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,22 @@ basic plane topology definitions, and a theory of combinatorial hypermaps.
## Building and installation instructions

The easiest way to install the latest released version of The Four Color Theorem
is via [OPAM](https://opam.ocaml.org/doc/Install.html):
is via [opam](https://opam.ocaml.org/doc/Install.html):

```shell
opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-fourcolor
```

To instead build and install manually, do:
If you are only interested in the formalization of real numbers, you can install
it separately:

```shell
opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-fourcolor-reals
```

To instead build and install the whole project manually from the repository, do:

``` shell
git clone https://github.com/coq-community/fourcolor.git
Expand All @@ -64,7 +72,6 @@ make # or make -j <number-of-cores-on-your-machine>
make install
```


## Documentation

The [Four Color Theorem](https://en.wikipedia.org/wiki/Four_color_theorem) (Appel & Haken, 1976) is a landmark result of graph theory.
Expand Down
28 changes: 28 additions & 0 deletions meta.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,34 @@ keywords:
categories:
- name: Mathematics/Combinatorics and Graph Theory

build: |-
## Building and installation instructions
The easiest way to install the latest released version of The Four Color Theorem
is via [opam](https://opam.ocaml.org/doc/Install.html):
```shell
opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-fourcolor
```
If you are only interested in the formalization of real numbers, you can install
it separately:
```shell
opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-fourcolor-reals
```
To instead build and install the whole project manually from the repository, do:
``` shell
git clone https://github.com/coq-community/fourcolor.git
cd fourcolor
make # or make -j <number-of-cores-on-your-machine>
make install
```
documentation: |-
## Documentation
Expand Down

0 comments on commit 1739214

Please sign in to comment.