~novakane/zig-fcft-example

dbae9712a53afef41fc209874bfd514905c57b90 — Hugo Machet 2 months ago cf26b65 main
README: Format
2 files changed, 24 insertions(+), 51 deletions(-)

A README
D README.md
A README => README +24 -0
@@ 0,0 1,24 @@
Port of example from upstream fcft to demonstrate zig-fcft bindings.

Requirements:
	zig 0.9
	fcft 3.0 (see fcft requirements if you want support for everything)

Init submodules:
    git submodule update --init

Build, e.g.
    zig build --prefix ~/.local

Usage: zig-fcft-example [options...]
  -h                Print this help message and exit.
  -text <TEXT>      Text string to render
  -font <FONTS>     Comma separated list of FontConfig formatted font specifications
  -bg <0xRRGGBBAA>  Background color (e.g. 0xff000077 for semi-transparent red)
  -fg <0xRRGGBBAA>  Foreground color (e.g. 0x00ff00ff for non-transparent green)

zig-fcft-example is licensed under the GNU General Public License v3.0 only

Files in common/ and protocol/ directories are released under various licenses
by various parties. You should refer to the copyright block of each files
for the licensing information.

D README.md => README.md +0 -51
@@ 1,51 0,0 @@
# Zig-fcft-example

Port of [example] from upstream fcft to demonstrate [zig-fcft] bindings.

## Building

Requirements:

-   [zig] 0.9
-   [fcft] 3.0 (see fcft [requirements] if you want support for everything)

Init submodules:

    git submodule update --init

Build, `e.g.`

    zig build --prefix ~/.local

## Usage

```
$ zig-fcft-example -h
Usage: zig-fcft-example [options...]

  -h                Print this help message and exit.
  -text <TEXT>      Text string to render
  -font <FONTS>     Comma separated list of FontConfig formatted font specifications
  -bg <0xRRGGBBAA>  Background color (e.g. 0xff000077 for semi-transparent red)
  -fg <0xRRGGBBAA>  Foreground color (e.g. 0x00ff00ff for non-transparent green)
```

## Contributing

See [CONTRIBUTING.md]

## License

zig-fcft-example is licensed under the [GNU General Public License v3.0 only]

Files in `common/` and `protocol/` directories are released under various
licenses by various parties. You should refer to the copyright block of each
files for the licensing information.

[example]: https://codeberg.org/dnkl/fcft/src/branch/master/example
[zig-fcft]: https://git.sr.ht/~novakane/zig-fcft
[zig]: https://ziglang.org/download/
[fcft]: https://codeberg.org/dnkl/fcft
[requirements]: https://codeberg.org/dnkl/fcft#requirements
[contributing.md]: CONTRIBUTING.md
[gnu general public license v3.0 only]: COPYING