Skip to content

Contributors.txt? #5

Closed
Closed

Description

@aquasock

A contributors document similar to Welcome.txt where a project can shout out people involved. You could have a formatting template in there for new projects.

Activity

  1. schikani commented on Oct 18, 2026

    @schikani
    Collaborator

    Thanks for the idea! I'd rather not build one fixed contributors file into TinyDesk itself: every port would carry the same text, and each port's people are different.

    Instead, I'm thinking of an optional list of default desktop files in the port's td_sysinfo_t, next to the existing extra About line: file names and contents that TinyDesk writes next to Welcome.txt when a user's Desktop folder is first created. TinyTang could then ship its own Credits.txt, and builds that don't set it pay nothing. Like Welcome.txt, the files are written once per user, so desktops that already exist won't get them. I'd add a suggested format for a credits file to the porting docs, and a CONTRIBUTORS.md in the repo for TinyDesk's own contributors.

    Would that cover what you had in mind?

  2. aquasock commented on Oct 19, 2026

    @aquasock
    Author

    Sounds perfect. I could always just ship my own doc on the desktop like I have been doing said but it would be nice to have a formal way to do it for all ports.

  3. schikani commented on Oct 29, 2026

    @schikani
    Collaborator

    The hook is ready to try: #10 (branch feature/desktop-files; CI passes, not merged to main yet).

    A port fills the new optional desktop_files member of td_sysinfo_t, and TinyDesk writes those files next to Welcome.txt when a user's Desktop folder is created:

    static const td_desktop_file_t s_desk_files[] = {
        {"Credits.txt", "TinyTang port of TinyDesk\n\nPort:      aquasock\n"},
        {NULL, NULL},
    };
    ...
    s_info.desktop_files = s_desk_files;

    Like Welcome.txt, they are written once per user, so to see them on a board that already has a Desktop, remove that user's ~/Desktop folder first. The docs, with a suggested Credits.txt format, are in tinydesk-project/tinydesk-project.github.io#1 ("Files for a new Desktop" in api/sysinfo.md). The PR also adds CONTRIBUTORS.md, where you're listed for TinyTang and this idea.

    Could you try it on TinyTang and let me know how it goes? I'll merge once it works for you, and this issue closes with it.

  4. added a commit that references this issue on Oct 31, 2026
  5. added a commit that references this issue on Nov 1, 2026
    caed895
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions