Merge pull request #133 from akirak/multi-licenses

Manage licenses

.gitattributes

@@ -1 +1,3 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: MIT
 *.mdoc linguist-language=Markdown

.gitignore

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2021-2025 Akira Komamura
+# SPDX-License-Identifier: MIT
 .pre-commit-config.yaml
 result
 flake.lock

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+Thank you for considering contributing to this project. Contributions help make
+this template repository more helpful. This guide outlines how to get involved,
+report issues, and submit changes.
+## Contributing the documentation
+If you have identified any errors in the instructions, please feel free to
+submit a pull request with your proposed changes.
+
+I would also appreciate any suggestions for enhancing the content. If you are
+aware of a better alternative to the described option, please feel free to open
+an issue or submit a PR.
+## Contributing to templates
+If you have noticed any error with one of the templates, please feel free to
+report an issue.

LICENSES/MIT.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2024 Akira Komamura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -282,6 +282,18 @@ Also see [nix3.el](https://github.com/emacs-twist/nix3.el), which
 provides `nix3-flake-new` and `nix3-flake-init` commands for running a
 flake template quickly from inside Emacs.
 
+## License
+This repository uses different licenses depending on the files. The specific
+license applicable to a file or group of files is indicated in the file headers
+or in the [LICENSES](LICENSES/) directory.
+
+- The templates are released under the UNLICENSE.
+  See [LICENSES/UNLICENSE](LICENSES/Unlicense.txt) for more details.
+- The documentation is licensed under Attribution-ShareAlike 4.0 International
+(CC-BY-SA-4.0).
+- Some files are released under the MIT License.
+## Contributing
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
 ## Other template repositories and alternatives
 
 The following is a list of template repositories I found on GitHub:

dev/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2023-2025 Akira Komamura
+# SPDX-License-Identifier: MIT
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

dev/update-beam.nix

@@ -1,6 +1,9 @@
 /*
   This script helps the user keep Erlang (erlangRxx) and Elixir (elixir_x_xx)
   to their latest versions. It performs simple regexp substitutions in flake.nix.
+
+  SPDX-FileCopyrightText: 2022-2025 Akira Komamura
+  SPDX-License-Identifier: MIT
 */
 {
   lib,

doc/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: MIT
 {
   inputs = {
     systems.url = "github:nix-systems/default";

doc/src/content/config.ts

@@ -1,3 +1,8 @@
+/*
+  SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+
+  SPDX-License-Identifier: MIT
+*/
 import { defineCollection } from "astro:content";
 import { docsSchema } from "@astrojs/starlight/schema";
 

doc/src/content/docs/configuration/editor/emacs.md

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Emacs
 description: How to set up Emacs for using Nix flakes.
 ---

doc/src/content/docs/configuration/nix-direnv.md

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Enable nix-direnv
 description: How to set up nix-direnv
 ---

doc/src/content/docs/getting-started.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Getting started with a flake template
 ---
 ## Configuration

doc/src/content/docs/index.mdx

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Nix Flake Templates
 description: A documentation site for Nix flake templates.
 tableOfContents: false

doc/src/content/docs/introduction.md

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Introduction to Flake Templates
 ---
 Hello, this site provides instructions for setting up a development environment

doc/src/content/docs/patterns/ci/github-actions.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Continuous Integration on GitHub Actions
 ---
 

doc/src/content/docs/patterns/formatting/treefmt-nix.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Checking formatting using treefmt-nix on GitHub Actions
 ---
 

doc/src/content/docs/patterns/updating/renovate.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Updating Packages with Mend Renovate
 ---
 This tutorial explains how to automatically updates packages using Renovate Bot.

doc/src/content/docs/recipes/elixir/phoenix.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Developing an Elixir Phoenix application
 description: How to develop an Elixir Phoenix with a Nix flake template
 ---

doc/src/content/docs/recipes/gleam/app.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Developing a Gleam application
 description: How to develop a server-side web application in Gleam with a Nix flake template
 ---

doc/src/content/docs/recipes/go/executable.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Developing a Go executable application
 ---
 

doc/src/content/docs/recipes/ocaml/generic.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Developing an OCaml project with Dune and Nix
 ---
 

doc/src/content/docs/recipes/rust/executable.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Developing a Rust program
 description: How to develop a Rust program with a Nix flake template
 ---

doc/src/content/docs/recipes/typescript/web-framework.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Developing a web application in TypeScript
 description: How to develop a web application in TypeScript with a Nix flake template
 ---

doc/src/content/docs/recipes/zig/cli.mdoc

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Developing a Zig CLI application
 ---
 

doc/src/content/docs/resources.md

@@ -1,4 +1,6 @@
 ---
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: CC-BY-SA-4.0
 title: Resources
 description: A collection of resources related to developing a project with Nix flakes.
 ---

doc/treefmt.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: MIT
 {
   projectRootFile = "treefmt.nix";
 

elixir-app/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2021-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

elixir/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2021-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

flake-parts/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

flake-utils/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2021-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2021-2025 Akira Komamura
+# SPDX-License-Identifier: MIT
 {
   description = "A collection of project templates";
 

gleam/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

go/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

go/treefmt.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   projectRootFile = "treefmt.nix";
 

meta/.github/workflows/nix-build.yml

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 name: Build the Nix package
 
 on:

meta/.github/workflows/nix-format.yml

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 name: Check format
 
 on:

meta/.gitignore

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 result
 result-*
 .pre-commit-hooks.yaml

minimal/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2021-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

node-typescript/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2021-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

ocaml/.env

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
+
 # The default cache path is immutable when odig is installed using Nix
 ODIG_CACHE_DIR="$PWD/_build/default/.odig"
 # Using _build directory may not be properly allowed for storing user contents

ocaml/.envrc

@@ -1,2 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
+
 dotenv
 use flake

ocaml/.gitignore

@@ -1 +1,3 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 _build

ocaml/.ocamlformat

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2017-2023, Facebook, Inc.
+# SPDX-FileCopyrightText: 2023-present, Tarides.
+# SPDX-License-Identifier: MIT
+
 # Latest version is available from
 # https://github.com/ocaml-ppx/ocamlformat/blob/main/.ocamlformat
 

ocaml/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     nixpkgs.url = "github:nix-ocaml/nix-overlays";

ocaml/justfile

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 odig-odoc:
     odig odoc
 

pre-commit/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2021-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

rust/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     flake-parts.url = "github:hercules-ci/flake-parts";

treefmt/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2023-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

treefmt/treefmt.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2023-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   projectRootFile = "treefmt.nix";
 

zig/.gitignore

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
+
 # Zig
 zig-out/
 .zig-cache/

zig/flake.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   inputs = {
     # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

zig/treefmt.nix

@@ -1,3 +1,5 @@
+# SPDX-FileCopyrightText: 2024-2025 Akira Komamura
+# SPDX-License-Identifier: Unlicense
 {
   projectRootFile = "treefmt.nix";