From fa8ebd3b6225f29ef3c2b46c7daad2d5fc00352e Mon Sep 17 00:00:00 2001 From: Emile Rolley Date: Sun, 7 May 2023 14:52:25 +0200 Subject: [PATCH] docs: update the generating website assets section from the INSTALL file --- INSTALL.md | 19 ++++++++++++++++--- generate_website_assets.sh | 4 ---- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 4f71adcf..ea513d9c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -128,20 +128,33 @@ To uninstall, use ### Generating website assets +#### Updating [`@catala-lang/catala-web-assets`](https://www.npmjs.com/package/@catala-lang/catala-web-assets) + The Catala website features assets generated by the Catala compiler. They are needed to build the website. To produce them, simply run make website-assets DUNE_PROFILE=release Then, use a helper script to copy them over to the `assets` directory of the -Catala website. +[`catala-web-assets`](https://github.com/CatalaLang/catala-web-assets) +repository. - ./generate_website_assets.sh /assets + ./generate_website_assets.sh /assets -You will need the `groff` executable to generate the HTML versions of the man +> You will need the `groff` executable to generate the HTML versions of the man pages, as well as the `rsync` executable to transfer files (preferred to `cp`) because it also works with a remote server. +#### Updating [`@catala-lang/french-law`](https://www.npmjs.com/package/@catala-lang/french-law) + +When a new version of the `french_law.js` (see the [dedicated +README](https://github.com/CatalaLang/catala/tree/master/french_law/js#generating-the-source-files) +to generate the lib) needs to be published, you need to execute from the +`french_law/js` directory, the following commands: + + npm version patch -m "Patch message" + npm publish + ## Syntax highlighting See the [dedicated `README.md`](./syntax_highlighting/README.md). diff --git a/generate_website_assets.sh b/generate_website_assets.sh index 0446f03a..66773362 100755 --- a/generate_website_assets.sh +++ b/generate_website_assets.sh @@ -26,9 +26,5 @@ rsync $BUILD/catala.html $1/ rsync $BUILD/clerk.html $1/ rsync $BUILD/catala_legifrance.html $1/ -# NOTE(@EmileRolley): the french_law.js is accessible through: -# https://www.npmjs.com/package/@catala-lang/french-law -# no need to copy it here. -# rsync $BUILD/french_law/js/french_law.js $1/french_law.js rsync $BUILD/examples/allocations_familiales/allocations_familiales_schema.json $1/ rsync $BUILD/examples/aides_logement/aides_logement_schema.json $1/