jj/demos
Ilya Grigoriev 6671971c8b demos: run run_scripts.sh to update demo PNGs
The changes to SVGs would be trivial, so they got
pushed to the previous commit.
2023-10-03 23:52:28 -07:00
..
demo_git_compat.sh demos: rearrange and reword portions of demos 2023-10-03 23:52:28 -07:00
demo_juggle_conflicts.sh demos: rearrange and reword portions of demos 2023-10-03 23:52:28 -07:00
demo_operation_log.sh demos: changes related to the new default log revset 2023-10-03 23:52:28 -07:00
demo_resolve_conflicts.sh demos: changes related to the new default log revset 2023-10-03 23:52:28 -07:00
demo_working_copy.sh demos: changes related to the new default log revset 2023-10-03 23:52:28 -07:00
git_compat.png demos: run run_scripts.sh to update demo PNGs 2023-10-03 23:52:28 -07:00
git_compat.svg demos: changes related to the new default log revset 2023-10-03 23:52:28 -07:00
helpers.sh demos: rearrange and reword portions of demos 2023-10-03 23:52:28 -07:00
juggle_conflicts.png demos: run run_scripts.sh to update demo PNGs 2023-10-03 23:52:28 -07:00
juggle_conflicts.svg demos: changes related to the new default log revset 2023-10-03 23:52:28 -07:00
operation_log.png demos: run run_scripts.sh to update demo PNGs 2023-10-03 23:52:28 -07:00
operation_log.svg demos: changes related to the new default log revset 2023-10-03 23:52:28 -07:00
README.md demos: add demos/README.md and run scripts to generate SVGs 2023-10-03 23:52:28 -07:00
resolve_conflicts.png demos: run run_scripts.sh to update demo PNGs 2023-10-03 23:52:28 -07:00
resolve_conflicts.svg demos: changes related to the new default log revset 2023-10-03 23:52:28 -07:00
run_scripts.sh demos: add demos/README.md and run scripts to generate SVGs 2023-10-03 23:52:28 -07:00
setup_standard_config.sh demos: make jj perform the line wrapping instead of term-transcript 2023-10-03 23:52:28 -07:00
working_copy.png demos: run run_scripts.sh to update demo PNGs 2023-10-03 23:52:28 -07:00
working_copy.svg demos: changes related to the new default log revset 2023-10-03 23:52:28 -07:00

Screenshots with demos and scripts to generate them

The demo_*.sh scripts in this directory demo various features of jj.

The run_scripts.sh script can be used to:

  • Run them inside a standardized environment instead of the user's local environment.
  • Generate SVG and PNG images for the scripts.

The PNG images in the repo may be slightly older, as they take up more space in the repo.

The SVG images have human-readable diffs, but may look different on different computers with different fonts installed.

Running run_scripts.sh

This requires ImageMagick and term-transcript-cli to be installed. See run_scripts.sh's error messages for some more details. On Debian Linux, it also seems helpful to sudo apt install inkscape; ImageMagick seems to use either Inkscape itself or some dependency of it.

One way to make all the images and check the output is:

cd demos
./run_scripts.sh demo_*.sh |less

A note on fonts

The exact PNG output depends on the fonts you have installed on your system.

The screenshots are usually generated on a Debian Linux system and use the "Fira Code" font. It can be installed with sudo apt install fonts-firacode. It seems to include all relevant Unicode symbols and be a little bolder and thus more readable than the "Liberation Mono" font, which is used if Fira Code is not installed. That font also works OK. See the CSS font specification in run_scripts.sh for other fonts tried (especially when viewing SVGs on the web). If none apply, the default monospace font will be used.

convert -list Fonts will list the fonts ImageMagick is aware of.