misc: update README

This commit is contained in:
Vladimir Stoiakin
2025-04-16 13:19:01 +03:00
parent dce41a6f07
commit fa985ec163
6 changed files with 13 additions and 17 deletions

View File

@@ -27,7 +27,7 @@ You can join our development chat at [#buffybox:matrix.org].
Some dependencies are included as git submodules in this repository. You can clone the repository and initialise the submodules with
```
$ git clone https://gitlab.com/postmarketOS/buffybox.git
$ git clone https://gitlab.postmarketos.org/postmarketOS/buffybox.git
$ cd buffybox
$ git submodule init
$ git submodule update

View File

@@ -10,12 +10,12 @@ echo "Uploading archive to GitLab..."
response=$(curl --request POST \
--header "PRIVATE-TOKEN: $1" \
--form "file=@${archive}" \
"https://gitlab.com/api/v4/projects/52322952/uploads")
"https://gitlab.postmarketos.org/api/v4/projects/172/uploads")
path=$(echo "${response}" | jq -r .full_path)
echo "${response}"
echo
echo "https://gitlab.com${path}"
echo "https://gitlab.postmarketos.org${path}"
rm -f "${archive}"

View File

@@ -13,7 +13,7 @@ Buffyboard uses [LVGL] for input processing and rendering. Key events are forwar
# Status
We are en route to v1 which aims at providing a useable, visually pleasant application including [fbkeyboard]'s most essential features. For details about the current status, see the [v1 milestone]. You may also browse the full list of [open issues] to get an idea of what's planned beyond v1.
We are en route to v1 which aims at providing a useable, visually pleasant application including [fbkeyboard]'s most essential features. You may browse the full list of [open issues] to get an idea of what's planned.
Here are a few highlights of what already works:
@@ -121,10 +121,9 @@ Buffyboard was inspired by [fbkeyboard].
[lv_port_linux_frame_buffer]: https://github.com/lvgl/lv_port_linux_frame_buffer
[lv_sim_emscripten]: https://github.com/lvgl/lv_sim_emscripten/blob/master/mouse_cursor_icon.c
[lvgl]: https://github.com/lvgl/lvgl
[open issues]: https://gitlab.com/cherrypicker/buffyboard/-/issues
[open issues]: https://gitlab.postmarketos.org/postmarketOS/buffybox/-/issues
[screenshots]: ./screenshots
[squeek2lvgl]: https://gitlab.com/cherrypicker/squeek2lvgl]
[squeek2lvgl]: ../squeek2lvgl
[squeekboard layouts]: https://gitlab.gnome.org/World/Phosh/squeekboard/-/blob/master/data/keyboards
[squeekboard's US terminal layout]: https://gitlab.gnome.org/World/Phosh/squeekboard/-/blob/master/data/keyboards/terminal/us.yaml
[squeekboard]: https://gitlab.gnome.org/World/Phosh/squeekboard/-/tree/master
[v1 milestone]: https://gitlab.com/cherrypicker/buffyboard/-/milestones/1

View File

@@ -15,19 +15,14 @@ if ! grep "## $1" CHANGELOG.md > /dev/null; then
exit 1
fi
if ! grep -E "^\s*version:\s*'$1'" buffyboard/meson.build > /dev/null; then
if ! grep -E "^\s*version:\s*'$1'" meson.build > /dev/null; then
echo "Error: Version $1 differs from version in buffyboard/meson.build"
exit 1
fi
if ! grep -E "^\s*version:\s*'$1'" unl0kr/meson.build > /dev/null; then
echo "Error: Version $1 differs from version in unl0kr/meson.build"
exit 1
fi
git tag "$1"
git push --tags
./archive.sh "$2"
echo "Now create a release for https://gitlab.com/postmarketOS/buffybox/-/tags/$1 and attach the uploaded archive"
echo "Now create a release for https://gitlab.postmarketos.org/postmarketOS/buffybox-/tags/$1 and attach the uploaded archive"

View File

@@ -4,7 +4,7 @@ squeek2lvgl is a Python script and an accompanying C library that make it possib
To access [squeekboard]'s layout files, squeek2lvgl shallowly clones the [squeekboard] git repository into a temporary directory and purges it before exiting.
**squeek2lvgl has been donated to the postmarketOS project. Development continues in https://gitlab.com/postmarketOS/buffybox.**
**squeek2lvgl has been donated to the postmarketOS project. Development continues in https://gitlab.postmarketos.org/postmarketOS/buffybox.**
## Usage

View File

@@ -49,6 +49,7 @@ Unl0kr values the CRYPTTAB_TRIED variable. Upon completion, the entered
password is printed to STDOUT. All other output happens on STDERR.
Mandatory arguments to long options are mandatory for short options too.
-m, --message A message that will be displayed to a user
-C, --config-override Path to a config override file. Can be supplied
multiple times. Config files are merged in the
following order:
@@ -69,6 +70,7 @@ Mandatory arguments to long options are mandatory for short options too.
* 2 - upside down orientation (180 degrees)
* 3 - counterclockwise orientation (270 degrees)
-h, --help Print this message and exit
-n Do not append a newline character to a password
-v, --verbose Enable more detailed logging output on STDERR
-V, --version Print the unl0kr version and exit
```
@@ -157,9 +159,9 @@ The [lv_port_linux_frame_buffer] project served as a starting point for the code
[lvgl]: https://github.com/lvgl/lvgl
[online font converter]: https://lvgl.io/tools/fontconverter
[osk-sdl]: https://gitlab.com/postmarketOS/osk-sdl
[package-arch]: https://aur.archlinux.org/packages/unl0kr
[package-arch]: https://aur.archlinux.org/packages/buffybox
[package-debian]: https://tracker.debian.org/pkg/unl0kr
[package-pmos]: https://gitlab.com/postmarketOS/pmaports/-/tree/master/main/unl0kr
[package-pmos]: https://gitlab.postmarketos.org/postmarketOS/pmaports/-/tree/master/main/unl0kr
[scdoc]: https://git.sr.ht/~sircmpwn/scdoc
[screenshots]: ./screenshots
[squeek2lvgl]: ../squeek2lvgl