https://github.com/johennes/buffybox
A suite of graphical applications for the terminal – Mirror of https://gitlab.com/postmarketOS/buffybox
https://github.com/johennes/buffybox
Last synced: 2 months ago
JSON representation
A suite of graphical applications for the terminal – Mirror of https://gitlab.com/postmarketOS/buffybox
- Host: GitHub
- URL: https://github.com/johennes/buffybox
- Owner: Johennes
- License: gpl-3.0
- Created: 2024-03-09T20:33:30.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-01T15:07:24.000Z (over 1 year ago)
- Last Synced: 2025-01-05T23:41:11.644Z (9 months ago)
- Language: C
- Size: 5.06 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
Awesome Lists containing this project
README
# BuffyBox
BuffyBox is a suite of graphical applications for the terminal.
## Components
### Standalone apps
**[buffyboard]** – Touch-enabled on-screen keyboard for virtual terminals
**[unl0kr]** – Disk unlocking UI for the initramfs
### Utilities
**[squeek2lvgl]** – Converter for transforming [Squeekboard] layouts into [LVGL]-compatible C code
**[shared]** – Internal code that is shared by some or all applications in the suite but not meant to be used externally
## Contributing
You can join our development chat at [#buffybox:matrix.org].
## Making a release
To make it easier for distributions to package BuffyBox, we include source tarballs including the LVGL submodule in GitLab releases. See [unl0kr#42] for more background on this.
Producing and uploading a source tarball requires [git-archive-all] to be installed as well as an access token for the GitLab API. To tag a release and upload a source tarball, run
```
./release.sh $VERSION $TOKEN
```
Once the upload completes, create a new release on GitLab and attach the URL of the uploaded source tarball.
## License
This project is licensed under the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
For the license of bundled images and fonts, see [shared/cursor] and [shared/fonts].
[#buffybox:matrix.org]: https://matrix.to/#/#buffybox:matrix.org
[buffyboard]: ./buffyboard
[git-archive-all]: https://github.com/Kentzo/git-archive-all
[LVGL]: https://github.com/lvgl/lvgl
[shared]: ./shared
[squeek2lvgl]: ./squeek2lvgl
[Squeekboard]: https://gitlab.gnome.org/World/Phosh/squeekboard
[shared/cursor]: ./shared/cursor
[shared/fonts]: ./shared/fonts
[unl0kr]: ./unl0kr
[unl0kr#42]: https://gitlab.com/cherrypicker/unl0kr/-/issues/42