Update README

Changes

1 changed files (+66/-1)

• README.md
  • @@ -18,4 +18,69 @@ -->
    # Plac - Unofficial [Roon](https://roon.app/) clients. + Third-party [Roon](https://roon.app/) clients. + + ## [Plac for GTK4](./gtk-adwaita/) + + (WIP) + + GTK4 application implemented using GNOME widgets. + Best suited for Linux, but it also works on other systems where GTK4 and libadwaita are installed. + + ## [Plac for macOS](./macos/) + + (WIP) + + macOS native application. + + ## License + + This project is licensed under [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0). + This project contains asset files licensed under [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode.en). + + Every file has [REUSE][reuse-license] annotation for copyright and license. + + ## Development + + ### Internal Packages + + #### [Core](./core/) + + Core logic available as C API, written in Zig. + This package provides clean API abstracting Roon API and networkings. + + #### [CLI](./cli/) + + Simple command line application for testing and profiling core API. + Internal only and not intended for real world uses. + + ### System Dependencies + + This project has `flake.nix` for development environment setup. + To start development shell, run: + + ``` + nix develop + ``` + + To develop without [Nix](https://nixos.org/) [Flakes](https://wiki.nixos.org/wiki/Flakes), install required dependencies listed at `outputs > devShell > packages` section in `flake.nix`. + + ### Code Formatting + + This project uses [dprint](https://dprint.dev/) as a code formatter frontend. + After installing system dependencies, you can format source code by: + + ``` + dprint fmt + ``` + + ### License Checking + + This project adheres to [REUSE][reuse-license] framework. + You can check files have valid REUSE annotations by: + + ``` + reuse lint + ``` + + [reuse-license]: https://reuse.software/