Commit Graph

23 Commits

Author SHA1 Message Date
40089b4836 docs: Update Cargo.lock instructions 2022-09-03 13:42:07 +00:00
bb22d9650b doc: Describe how to control debugging mode 2022-06-06 16:10:03 +00:00
dcz
a413146888 Merge branch 'dooc' into 'master'
docs: Describe layouts

See merge request World/Phosh/squeekboard!549
2022-04-28 15:05:38 +00:00
111c0d157f docs: Describe layouts 2022-04-20 14:52:25 +00:00
6867f48bf9 docs: Make index more logical 2022-04-17 07:35:32 +00:00
71942f7221 docs: Link to reference 2022-04-17 07:31:29 +00:00
db6109b298 docs: Detail the release process better 2022-01-25 11:22:31 +00:00
7a07f1616d ci: Include pre-build style check 2021-12-09 11:42:33 +00:00
1b13df3364 docs: Move env vars section to debugging 2021-12-05 17:47:37 +00:00
82c320a075 Merge branch 'release' into HEAD 2021-08-19 12:22:12 +00:00
c641035b1a Update tutorial.md to clarify steps in creating a custom layout 2021-07-20 20:00:42 +00:00
97c7c4557d Docs: Release procedure 2021-05-22 14:25:57 +00:00
225e53df07 docs: Describe view switching 2021-04-01 12:41:51 +00:00
c9f9a3b577 Merge branch 'cargo' into 'master'
docs: Correct Cargo update instructions

See merge request Librem5/squeekboard!398
2020-11-23 09:16:59 +00:00
153f9c39e5 lint: Check for missing braces
The `eek/layersurface.c` file should be excluded because it's an imported, "foreign" source, but clang-tidy doesn't seem to have an annotation for that.

An alternative would have been to exclude it in Meson and do the check there, but that requires clang-tidy, raising the barrier to contribute of Squeekboard even more (it already requires libfeedback, which isn't packaged widely).
2020-10-20 11:34:17 +00:00
5d81cf78f8 docs: Correct Cargo update instructions 2020-10-19 14:33:08 +00:00
07bcaa8e2b docs: Reorganize tutorial
People still ignore adding layouts to builtins and to tests. To unbury that information, and add a sort of checklist, the more interesting info has been moved upwards nd together.
2020-10-01 11:52:53 +00:00
c16c686592 docs: Tutorial syntax cleanups
Promoted bolded "headings" into actual headings, so that they can be linked to.
2020-09-29 13:33:37 +00:00
7aa004ceff Fix spelling mistakes in doc/hacking.md
Fixes #217
2020-09-25 21:44:27 +10:00
ecfc45c2de build: Make compatible with Debian Bullseye
This commit is a bit bigger than it could have: Meson changes could have gone in separately from CI and Debian.

This commit looks more complicated than it should reasonably be. Alas, Cargo is a piece of work, and it doesn't let honest people just choose different versions of dependencies, leading to a cascade of misery. Several things were tried to curb the disaster:

- Cargo [feature] supports choosing dependencies, but doesn't support specifying dependency versions
- Cargo has a cfg() syntax in sections for choosing dependencies by build options, but it explicitly doesn't support selecting on features…
- Cargo allows choosing different dependencies based on features, so perhaps dependencies with different versions could live in stub crates pulled in as needed? Nope! If a dependency doesn't exist in the repo (and that's the point here), Cargo throws up its hands.

This means Cargo.toml needs to be generated based on the build type. More misery:

- we lose the simplicity of just doing `cargo.sh` for simple housekeeping like deps updates. HACKING.md was updated to reflect that. Perhaps that's inevitable - build options need to be like this.
- Some flaky adjustments needed in `cargo.sh` because of an additional argument that can be mistaken for an argument to the exec in `cargo run`.
- Specifying a custom `Cargo.toml` means Cargo can no longer find any tests, examples, benchmarks, or binaries, because it searches relative to the directory of `Cargo.toml`, which is now the build dir. Extra care needed to not forget about them now.

As soon as Cargo allows anything better for managing deps versions, the above should be undone in its favor.

Good side is that a couple bugs went away:

- build flags not always making it to Cargo
- arm64 builds were optional while they shouldn't
- test layouts in unit tests are loaded from an explicit directory now

The Bullseye versions of dependencies are canonical now, Buster considered legacy.
2020-06-24 15:51:21 +00:00
8f3d010349 hacking: Move into docs/ 2020-02-28 14:10:44 +00:00
83fe2757ef Tidy build file and docs 2020-01-30 16:51:20 +01:00
0e1bf19737 docs: Create with tutorial
Create docs, based on Sphinx with Commonmark, seeding it with https://forums.puri.sm/t/translations-and-virtual-touch-keyboards-tracking-localization/7669/48?u=dcz
2019-12-15 21:53:18 +00:00