From 8809e6efa245066e00d6a38390054a092a0a9c2f Mon Sep 17 00:00:00 2001 From: Louis Gesbert Date: Tue, 16 Jan 2024 17:11:54 +0100 Subject: [PATCH] Fix a few references to the removed examples/ dir --- CONTRIBUTING.md | 16 +++++++++------- README.md | 2 +- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c09a3c8..55f9169a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,10 +21,10 @@ distributed under the Apache2 license. Before writing Catala code, please read the [tutorial](https://catala-lang.org/en/examples/tutorial). You can run the -programs of the tutorial yourself by following the instruction in the -[README of the `examples` directory](examples/README.md). Then, it is suggested -that you create a new example directory again according to the instructions of -this README. +programs of the tutorial yourself by following the instruction in the [README of +the `examples` repository](https://github.com/CatalaLang/catala-examples/README.md). +Then, it is suggested that you create a new example directory again according to +the instructions of this README. Let us now present the typical Catala workflow. First, you need to locate the legislative text that you want to use as a reference. Then, simply @@ -77,9 +77,11 @@ declaration structure FooBar: ``` ```` -Again, make sure to regularly check that your example is parsing correctly. The error message from the compiler should help you debug the syntax if need be. You can also -live-test the programs you wrote by feeding them to the interpreter -(see the [README of the `examples` directory](examples/README.md)); this will +Again, make sure to regularly check that your example is parsing correctly. The +error message from the compiler should help you debug the syntax if need be. You +can also live-test the programs you wrote by feeding them to the interpreter +(see the [README of the `examples` +repository](https://github.com/CatalaLang/catala-examples/README.md)); this will also type-check the programs, which is useful for debugging them. ## Working on the compiler diff --git a/README.md b/README.md index c1687bdc..0358188e 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,7 @@ to generate the documentation, then open the `doc/odoc.html` file in any browser ## Examples To explore the different programs written in Catala, see -[the dedicated readme](examples/README.md). +[the dedicated readme](https://github.com/CatalaLang/catala-examples/README.md). ## API