CatalaLang/catala
1
1
Fork 0
mirror of https://github.com/CatalaLang/catala.git synced 2024-11-08 07:51:43 +03:00
Code Issues Projects Releases Wiki Activity

docs: update the generating website assets section from the INSTALL file

Browse Source
This commit is contained in:
Emile Rolley 2023-05-07 14:52:25 +02:00 committed by Emile Rolley
parent 4637260b1e
commit fa8ebd3b62
2 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
INSTALL.md
View File

@ -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 <path-to-catala-website>/assets
./generate_website_assets.sh <path-to-catala-web-assets>/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).

4
generate_website_assets.sh
View File

@ -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/