Changes after removing most of the wiki #1246
Conversation
eponier
commented
Jul 18, 2025
eponier
commented
- move installation instructions to the doc
- move jasmin.sty to the doc
- extend the README
|
you may want to change that line too: jasmin/compiler/src/latex_printer.ml Line 464 in 4bc58de |
eponier
force-pushed
the
update-README-after-wiki-cleaning
branch
from
4bc58de to
ffbdf20
Compare
|
Well spotted! |
| - with nix | ||
| ``` | ||
| nix-env -iA nixpkgs.jasmin-compiler | ||
| ``` | ||
|
|
||
| - with opam | ||
| ``` | ||
| opam install jasmin | ||
| ``` | ||
|
|
||
| - with APT (debian, ubuntu), a package is available in a dedicated repository, see the [documentation](https://jasmin-lang.readthedocs.io/en/latest/misc/installation_instructions.html#debian-packages) | ||
|
|
||
| - from source, see the [documentation](https://jasmin-lang.readthedocs.io/en/latest/misc/installation_instructions.html) |
There was a problem hiding this comment.
Why do you repeat what is in the manual? I think that a link to the manual is as useful and less prone to errors.
| F.fprintf fmt "@[%% jasmincode environment provided by the jasmin package@]@ "; | ||
| F.fprintf fmt "@[%% defined in file: @]@ "; | ||
| F.fprintf fmt "@[%% https://github.com/jasmin-lang/jasmin/wiki/resources/jasmin.sty@]@ "; | ||
| F.fprintf fmt "@[%% https://jasmin-lang.readthedocs.io/en/latest/tools/jasmin.sty@]@ "; |
There was a problem hiding this comment.
In fact, I think that it is too early for this change. The way our deployment of documentation is coupled to our release management means that we must first wait for the jasmin.sty file to be deployed at the target address (i.e., wait for next tag to be set in the repo) before we can change the link in the source code.
| jasmin2tex -o output.tex input.jazz | ||
|
|
||
| The produced LATEX snippet is meant to be included in a `jasmincode` environment provided by the `jasmin` package defined in the following file: [jasmin.sty](./resources/jasmin.sty). | ||
| The produced LATEX snippet is meant to be included in a `jasmincode` environment provided by the `jasmin` package defined in the following file: [jasmin.sty](jasmin.sty). |
There was a problem hiding this comment.
This will not work: you need to tell sphinx to install the jasmin.sty file.
