diff --git a/docs/development.md b/docs/development.md index 69936cce8..9c8090ac2 100644 --- a/docs/development.md +++ b/docs/development.md @@ -33,7 +33,7 @@ On all platforms, you will need to install: to use a distro-provided Rust, newer Rust versions will typically work for building but may fail tests; older Rust versions may not work at all. - Ninja (unzip from https://github.com/ninja-build/ninja/releases/tag/v1.11.1 and - place on your path, or from your distro if it's 1.10+) + place on your path, or from your distro/homebrew if it's 1.10+) Platform-specific requirements: diff --git a/docs/linux.md b/docs/linux.md index 728fbf9fd..5fbda5c98 100644 --- a/docs/linux.md +++ b/docs/linux.md @@ -3,7 +3,8 @@ ## Requirements These instructions are written for Debian/Ubuntu; adjust for your distribution. -Some extra notes have been provided by a forum member: +Some extra notes have been provided by a forum member, though some of the things +mentioned there no longer apply: https://forums.ankiweb.net/t/guide-how-to-build-and-run-anki-from-source-with-xubuntu-20-04/12865 You can see a full list of buildtime and runtime requirements by looking at the @@ -21,7 +22,10 @@ Users on ARM64, see the notes at the bottom of this file before proceeding. $ sudo apt install bash grep findutils curl gcc g++ git rsync ninja-build ``` -The 'find' utility is 'findutils' on Debian. +- The 'find' utility is 'findutils' on Debian. +- Your distro may call the package 'ninja' instead of 'ninja-build', or it + may not have a version new enough - if so, install from the zip mentioned in + development.md. ## Missing Libraries @@ -63,6 +67,16 @@ There are a few things to be aware of: on Qt6 environments. - Some of the './ninja check' tests are broken on ARM Linux. +## Packaging considerations + +Python and node are downloaded as part of the build. You can optionally define +PYTHON_BINARY as the full path to a Python binary, to use it instead of the downloaded +version. A similar approach could be done with node in the future; a PR would be +welcome. + +If rust-toolchain.toml is removed, newer Rust versions can be used. Older versions +may or may not compile the code. + ## More For info on running tests, building wheels and so on, please see [Development](./development.md).