|
| 1 | +--- |
| 2 | +title: "Installing" |
| 3 | +description: | |
| 4 | + Instructions for installing the required (and optional) programs to use this |
| 5 | + template and create a new project from it. |
| 6 | +order: 1 |
| 7 | +--- |
| 8 | + |
| 9 | +There are a few programs that are required to use this template to |
| 10 | +create a project: |
| 11 | + |
| 12 | +- [uv](https://docs.astral.sh/uv/): A tool for managing Python |
| 13 | + environments and running commands. |
| 14 | +- [Python](https://www.python.org/): Required by Copier, the template |
| 15 | + tool. |
| 16 | +- [Copier](https://copier.readthedocs.io/en/stable/): A template tool |
| 17 | + for making new projects in a standardised and structured way. |
| 18 | +- [just](https://just.systems/man/en/): A build and development |
| 19 | + management tool that helps with running common build and check tasks. |
| 20 | + |
| 21 | +You can use uv to install these required programs, so |
| 22 | +[install](https://docs.astral.sh/uv/getting-started/installation/) that |
| 23 | +first. After you've installed uv, install the other programs using: |
| 24 | + |
| 25 | +```{.bash filename="Terminal"} |
| 26 | +uv tool install copier rust-just |
| 27 | +``` |
| 28 | + |
| 29 | +uv will also install Python for you when you install these tools. |
| 30 | + |
| 31 | +There are some optional, though **strongly recommended**, programs to |
| 32 | +install and use in any project created with this template: |
| 33 | + |
| 34 | +- [Git](https://git-scm.com/): For version control and setting up Git to |
| 35 | + track the newly created project. |
| 36 | +- [Lychee](https://lychee.cli.rs/guides/getting-started/): A link |
| 37 | + checker that we include in the `justfile` for checking for broken |
| 38 | + links in the files. |
| 39 | +- [Quarto](https://quarto.org/): A scientific and technical publishing |
| 40 | + system built on Pandoc. The website built with this template is |
| 41 | + created with Quarto, and the project created from this template is |
| 42 | + also set up to use Quarto too. |
| 43 | +- [gh cli](https://cli.github.com/): For managing GitHub repositories |
| 44 | + and settings from the command line. There are some post-creation steps |
| 45 | + we've included that use gh to simplify setting up a GitHub repository |
| 46 | + for the project. |
0 commit comments