Create README.md

Changes

1 changed files (+101/-0)

• README.md (new)
  • @@ -0,0 +1,101 @@
    + <!-- + Copyright 2026 Shota FUJI + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at https://mozilla.org/MPL/2.0/. + + SPDX-License-Identifier: MPL-2.0 + --> + + # CLT + + Configurable Leathercraft Templates, my personal leathercraft templates. + + I'm an amateur and these designs are my learning process. + Use at your own risk. + + Available at <https://clt.pocka.jp/>. + + ## Licenses + + - Template design and related source code: [CC-BY-4.0](./LICENSES/CC-BY-4.0.txt) + - Rest of the application source code, config files: [MPL-2.0](./LICENSES/MPL-2.0.txt) + + This repository contains vendored files at [vendor/](./vendor/) directory. + [vendor/REUSE.toml](./vendor/REUSE.toml) states the licenses of each vendored projects. + + ## Development + + Use of [Nix Flakes](https://wiki.nixos.org/wiki/Flakes) is the recommended way to setup a development environment. + + ### Building + + For cache enabled builds, enter Nix devShell then run `zig build`: + + ```sh + nix develop + zig build + ``` + + This generates static files at `zig-out/` directory. + + Add `--watch` option to [Zig](https://ziglang.org/) to compile on file changes: + + ```sh + nix develop + zig build --watch + ``` + + Add `-Doptimize=ReleaseSafe` to disable [Elm](https://elm-lang.org/) debugger and optimize JavaScript file using [Closure Compiler](https://developers.google.com/closure/compiler). + + ```sh + nix develop + zig build -Doptimize=ReleaseSafe + # You can add "--watch" too, but beware, closure-compiler is soooo slow. + ``` + + Or simply run `nix build`: + + ```sh + nix build + ``` + + This generates static files at `result/` directory. + + ### Serving + + To quickly serve `zig-out/` locally, this project has [`Caddyfile`](./Caddyfile) so you can simply run, + + ```sh + nix run .#caddy run + + # or "caddy run" for non-Flakes setup + ``` + + and you can access built files at <http://localhost:8080>. + + ### Formatting + + This project uses [EditorConfig](https://editorconfig.org/) for base convention and [dprint](https://dprint.dev/) for source code formatting. + + ```sh + nix fmt + + # or "dprint fmt" for non-Flakes setup + ``` + + ### Licenses Checking + + Every file inside this repository has to adhere to [REUSE](https://reuse.software/), a specification for copyright and license information annotation. + Use the [REUSE tool](https://codeberg.org/fsfe/reuse-tool) to validate and manage copyright and license information. + + ```sh + # Checks every file adheres to the REUSE specification. + nix run .#reuse lint + + # Show help text for the REUSE tool. + nix run .#reuse -- --help + + # non-Flakes equivalents are "reuse lint" and "reuse --help" + ```