initialised with COSMIC app template

2026-03-10 17:55:38 +10:00
commit b9c1315974
13 changed files with 717 additions and 0 deletions
@@ -0,0 +1,44 @@
+# Planit
+
+A COSMIC todo.txt application
+
+## Installation
+
+A [justfile](./justfile) is included by default for the [casey/just][just] command runner.
+
+- `just` builds the application with the default `just build-release` recipe
+- `just run` builds and runs the application
+- `just install` installs the project into the system
+- `just vendor` creates a vendored tarball
+- `just build-vendored` compiles with vendored dependencies from that tarball
+- `just check` runs clippy on the project to check for linter warnings
+- `just check-json` can be used by IDEs that support LSP
+
+## Translators
+
+[Fluent][fluent] is used for localization of the software. Fluent's translation files are found in the [i18n directory](./i18n). New translations may copy the [English (en) localization](./i18n/en) of the project, rename `en` to the desired [ISO 639-1 language code][iso-codes], and then translations can be provided for each [message identifier][fluent-guide]. If no translation is necessary, the message may be omitted.
+
+## Packaging
+
+If packaging for a Linux distribution, vendor dependencies locally with the `vendor` rule, and build with the vendored sources using the `build-vendored` rule. When installing files, use the `rootdir` and `prefix` variables to change installation paths.
+
+```sh
+just vendor
+just build-vendored
+just rootdir=debian/planit prefix=/usr install
+```
+
+It is recommended to build a source tarball with the vendored dependencies, which can typically be done by running `just vendor` on the host system before it enters the build environment.
+
+## Developers
+
+Developers should install [rustup][rustup] and configure their editor to use [rust-analyzer][rust-analyzer]. To improve compilation times, disable LTO in the release profile, install the [mold][mold] linker, and configure [sccache][sccache] for use with Rust. The [mold][mold] linker will only improve link times if LTO is disabled.
+
+[fluent]: https://projectfluent.org/
+[fluent-guide]: https://projectfluent.org/fluent/guide/hello.html
+[iso-codes]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
+[just]: https://github.com/casey/just
+[rustup]: https://rustup.rs/
+[rust-analyzer]: https://rust-analyzer.github.io/
+[mold]: https://github.com/rui314/mold
+[sccache]: https://github.com/mozilla/sccache