Repository navigation
Desktop: ports can put their own files on new Desktops - #10
Merged
Merged
Conversation
td_sysinfo_t.desktop_files lists files (name and contents, ended by a NULL name) that TinyDesk writes next to Welcome.txt when a user's Desktop folder is created, such as a port's Credits.txt. Like Welcome.txt they are written once per user; names that are not plain file names are skipped, and builds that leave it NULL are unchanged. tests/test_desktop.c covers new and existing Desktops, bad entries and no list. CONTRIBUTORS.md lists the people who made TinyDesk and TinyDesk Shell; README and CONTRIBUTING point to it. Closes #5.
This was referenced Oct 29, 2026
Closed
schikani
added a commit
to tinydesk-project/tinydesk-project.github.io
that referenced
this pull request
Oct 31, 2026
Documents the desktop-files hook from tinydesk-project/tinydesk#10 (tinydesk #5): td_sysinfo_t.desktop_files lists file names and contents that TinyDesk writes next to Welcome.txt when a user's Desktop folder is created, for example a port's Credits.txt. Written once per user, like Welcome.txt; builds that do not set it are unchanged. - api/sysinfo.md: new section "Files for a new Desktop" with the member, its type and an example. - api/apps.md, ports/overview.md, shell/config-files.md: the Desktop folder is created with Welcome.txt and the port's own files. - contributing.md: CONTRIBUTORS.md in the tinydesk repository lists the people who made TinyDesk and TinyDesk Shell; add yourself in your pull request. - changelog.md: "Unreleased" entries for both.
schikani
added a commit
that referenced
this pull request
Oct 31, 2026
Conflict in CMakeLists.txt: both added a test (test_py_pins and test_desktop); both kept.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #5.
Ports can now put their own files on every new Desktop, as discussed in #5.
td_sysinfo_t.desktop_files(optional) is a list of file names and contents, ended by an entry withnameNULL. When a user's Desktop folder is created, TinyDesk writesWelcome.txtand then these files into it, for example a port'sCredits.txt.Welcome.txt, they are written once per user: Desktops that already exist don't get them, and a user may edit or delete them./,\, empty,.,..), as are entries with no text.NULLare unchanged: onlyWelcome.txt.CONTRIBUTORS.mdlists the people who made TinyDesk and TinyDesk Shell;README.mdandCONTRIBUTING.mdpoint to it.Tests:
tests/test_desktop.c(15 checks, in-memory filesystem): a new Desktop getsWelcome.txtand the port's files, bad entries are skipped, each new user gets their own copies, an existing Desktop is left alone (an edited file stays edited), and no list means onlyWelcome.txt. All 11 host tests pass on Windows (MinGW).Docs, with the suggested
Credits.txtformat: tinydesk-project/tinydesk-project.github.io, branchfeature/desktop-files.