From a87269d22406c9b56df2bea3f35fbe1c4c65b853 Mon Sep 17 00:00:00 2001 From: Akira Komamura Date: Sun, 19 Jan 2025 10:49:47 +0900 Subject: [PATCH 1/6] docs: Collect license files into the licenses directory --- doc/LICENSE.txt => LICENSES/CC-BY-SA-4.0.txt | 0 LICENSES/MIT.txt | 21 ++++++++++++++++++++ LICENSE => LICENSES/Unlicense.txt | 0 3 files changed, 21 insertions(+) rename doc/LICENSE.txt => LICENSES/CC-BY-SA-4.0.txt (100%) create mode 100644 LICENSES/MIT.txt rename LICENSE => LICENSES/Unlicense.txt (100%) diff --git a/doc/LICENSE.txt b/LICENSES/CC-BY-SA-4.0.txt similarity index 100% rename from doc/LICENSE.txt rename to LICENSES/CC-BY-SA-4.0.txt diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..96cd942 --- /dev/null +++ b/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. diff --git a/LICENSE b/LICENSES/Unlicense.txt similarity index 100% rename from LICENSE rename to LICENSES/Unlicense.txt From 1c1271d73cc4fd0d02e2ab21ca63243a28ced67c Mon Sep 17 00:00:00 2001 From: Akira Komamura Date: Sun, 19 Jan 2025 10:51:14 +0900 Subject: [PATCH 2/6] docs: Add the SPDX license identifier for the doc --- doc/src/content/docs/configuration/editor/emacs.md | 2 ++ doc/src/content/docs/configuration/nix-direnv.md | 2 ++ doc/src/content/docs/getting-started.mdoc | 2 ++ doc/src/content/docs/index.mdx | 2 ++ doc/src/content/docs/introduction.md | 2 ++ doc/src/content/docs/patterns/ci/github-actions.mdoc | 2 ++ doc/src/content/docs/patterns/formatting/treefmt-nix.mdoc | 2 ++ doc/src/content/docs/patterns/updating/renovate.mdoc | 2 ++ doc/src/content/docs/recipes/elixir/phoenix.mdoc | 2 ++ doc/src/content/docs/recipes/gleam/app.mdoc | 2 ++ doc/src/content/docs/recipes/go/executable.mdoc | 2 ++ doc/src/content/docs/recipes/ocaml/generic.mdoc | 2 ++ doc/src/content/docs/recipes/rust/executable.mdoc | 2 ++ doc/src/content/docs/recipes/typescript/web-framework.mdoc | 2 ++ doc/src/content/docs/recipes/zig/cli.mdoc | 2 ++ doc/src/content/docs/resources.md | 2 ++ 16 files changed, 32 insertions(+) diff --git a/doc/src/content/docs/configuration/editor/emacs.md b/doc/src/content/docs/configuration/editor/emacs.md index b3094d0..7e4abfb 100644 --- a/doc/src/content/docs/configuration/editor/emacs.md +++ b/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. --- diff --git a/doc/src/content/docs/configuration/nix-direnv.md b/doc/src/content/docs/configuration/nix-direnv.md index 3952fe4..326a2bf 100644 --- a/doc/src/content/docs/configuration/nix-direnv.md +++ b/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 --- diff --git a/doc/src/content/docs/getting-started.mdoc b/doc/src/content/docs/getting-started.mdoc index a996c38..78a4220 100644 --- a/doc/src/content/docs/getting-started.mdoc +++ b/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 diff --git a/doc/src/content/docs/index.mdx b/doc/src/content/docs/index.mdx index 4a65b53..8bb799e 100644 --- a/doc/src/content/docs/index.mdx +++ b/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 diff --git a/doc/src/content/docs/introduction.md b/doc/src/content/docs/introduction.md index cf4bb8e..0118225 100644 --- a/doc/src/content/docs/introduction.md +++ b/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 diff --git a/doc/src/content/docs/patterns/ci/github-actions.mdoc b/doc/src/content/docs/patterns/ci/github-actions.mdoc index 34db89e..555fd25 100644 --- a/doc/src/content/docs/patterns/ci/github-actions.mdoc +++ b/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 --- diff --git a/doc/src/content/docs/patterns/formatting/treefmt-nix.mdoc b/doc/src/content/docs/patterns/formatting/treefmt-nix.mdoc index 92b2ff9..fc554cd 100644 --- a/doc/src/content/docs/patterns/formatting/treefmt-nix.mdoc +++ b/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 --- diff --git a/doc/src/content/docs/patterns/updating/renovate.mdoc b/doc/src/content/docs/patterns/updating/renovate.mdoc index 435c9ab..c220579 100644 --- a/doc/src/content/docs/patterns/updating/renovate.mdoc +++ b/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. diff --git a/doc/src/content/docs/recipes/elixir/phoenix.mdoc b/doc/src/content/docs/recipes/elixir/phoenix.mdoc index 4934f79..7659871 100644 --- a/doc/src/content/docs/recipes/elixir/phoenix.mdoc +++ b/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 --- diff --git a/doc/src/content/docs/recipes/gleam/app.mdoc b/doc/src/content/docs/recipes/gleam/app.mdoc index 732c42b..21df700 100644 --- a/doc/src/content/docs/recipes/gleam/app.mdoc +++ b/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 --- diff --git a/doc/src/content/docs/recipes/go/executable.mdoc b/doc/src/content/docs/recipes/go/executable.mdoc index d9e7481..0ba3d4f 100644 --- a/doc/src/content/docs/recipes/go/executable.mdoc +++ b/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 --- diff --git a/doc/src/content/docs/recipes/ocaml/generic.mdoc b/doc/src/content/docs/recipes/ocaml/generic.mdoc index 8ff47ce..96d7762 100644 --- a/doc/src/content/docs/recipes/ocaml/generic.mdoc +++ b/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 --- diff --git a/doc/src/content/docs/recipes/rust/executable.mdoc b/doc/src/content/docs/recipes/rust/executable.mdoc index e8ec5eb..ff774e6 100644 --- a/doc/src/content/docs/recipes/rust/executable.mdoc +++ b/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 --- diff --git a/doc/src/content/docs/recipes/typescript/web-framework.mdoc b/doc/src/content/docs/recipes/typescript/web-framework.mdoc index ec6b82c..14fe9df 100644 --- a/doc/src/content/docs/recipes/typescript/web-framework.mdoc +++ b/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 --- diff --git a/doc/src/content/docs/recipes/zig/cli.mdoc b/doc/src/content/docs/recipes/zig/cli.mdoc index 014b4fd..82901ae 100644 --- a/doc/src/content/docs/recipes/zig/cli.mdoc +++ b/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 --- diff --git a/doc/src/content/docs/resources.md b/doc/src/content/docs/resources.md index 20314e2..4f51c4f 100644 --- a/doc/src/content/docs/resources.md +++ b/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. --- From 2484aadbf4b7dc7a36e44294654ebab5ab88ce0a Mon Sep 17 00:00:00 2001 From: Akira Komamura Date: Sun, 19 Jan 2025 11:03:17 +0900 Subject: [PATCH 3/6] docs: Add Unlicense SPDX license identifiers to the templates --- elixir-app/flake.nix | 2 ++ elixir/flake.nix | 2 ++ flake-parts/flake.nix | 2 ++ flake-utils/flake.nix | 2 ++ gleam/flake.nix | 2 ++ go/flake.nix | 2 ++ go/treefmt.nix | 2 ++ meta/.github/workflows/nix-build.yml | 2 ++ meta/.github/workflows/nix-format.yml | 2 ++ meta/.gitignore | 2 ++ minimal/flake.nix | 2 ++ node-typescript/flake.nix | 2 ++ ocaml/.env | 3 +++ ocaml/.envrc | 3 +++ ocaml/.gitignore | 2 ++ ocaml/.ocamlformat | 4 ++++ ocaml/flake.nix | 2 ++ ocaml/justfile | 2 ++ pre-commit/flake.nix | 2 ++ rust/flake.nix | 2 ++ treefmt/flake.nix | 2 ++ treefmt/treefmt.nix | 2 ++ zig/.gitignore | 3 +++ zig/flake.nix | 2 ++ zig/treefmt.nix | 2 ++ 25 files changed, 55 insertions(+) diff --git a/elixir-app/flake.nix b/elixir-app/flake.nix index 1c360c1..8b329e9 100644 --- a/elixir-app/flake.nix +++ b/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"; diff --git a/elixir/flake.nix b/elixir/flake.nix index f6bebf4..c3f4c47 100644 --- a/elixir/flake.nix +++ b/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"; diff --git a/flake-parts/flake.nix b/flake-parts/flake.nix index d47defb..1061b6a 100644 --- a/flake-parts/flake.nix +++ b/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"; diff --git a/flake-utils/flake.nix b/flake-utils/flake.nix index 5281e21..e1e094d 100644 --- a/flake-utils/flake.nix +++ b/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"; diff --git a/gleam/flake.nix b/gleam/flake.nix index 819dcfe..b2738c4 100644 --- a/gleam/flake.nix +++ b/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"; diff --git a/go/flake.nix b/go/flake.nix index 47bd0af..8b93057 100644 --- a/go/flake.nix +++ b/go/flake.nix @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2024 Akira Komamura +# SPDX-License-Identifier: Unlicense { inputs = { # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; diff --git a/go/treefmt.nix b/go/treefmt.nix index 2fafa9f..0ef595d 100644 --- a/go/treefmt.nix +++ b/go/treefmt.nix @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2024 Akira Komamura +# SPDX-License-Identifier: Unlicense { projectRootFile = "treefmt.nix"; diff --git a/meta/.github/workflows/nix-build.yml b/meta/.github/workflows/nix-build.yml index 8b050b3..bc7b06d 100644 --- a/meta/.github/workflows/nix-build.yml +++ b/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: diff --git a/meta/.github/workflows/nix-format.yml b/meta/.github/workflows/nix-format.yml index e1352dd..5a51e53 100644 --- a/meta/.github/workflows/nix-format.yml +++ b/meta/.github/workflows/nix-format.yml @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: Unlicense name: Check format on: diff --git a/meta/.gitignore b/meta/.gitignore index 8a75cf9..516f1ee 100644 --- a/meta/.gitignore +++ b/meta/.gitignore @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: Unlicense result result-* .pre-commit-hooks.yaml diff --git a/minimal/flake.nix b/minimal/flake.nix index 789605f..2314d4f 100644 --- a/minimal/flake.nix +++ b/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"; diff --git a/node-typescript/flake.nix b/node-typescript/flake.nix index ec68fe9..b9fd3e6 100644 --- a/node-typescript/flake.nix +++ b/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"; diff --git a/ocaml/.env b/ocaml/.env index 51602f0..5f1373a 100644 --- a/ocaml/.env +++ b/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 diff --git a/ocaml/.envrc b/ocaml/.envrc index 0b1a02d..5a7ff4f 100644 --- a/ocaml/.envrc +++ b/ocaml/.envrc @@ -1,2 +1,5 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: Unlicense + dotenv use flake diff --git a/ocaml/.gitignore b/ocaml/.gitignore index e35d885..0c37cf1 100644 --- a/ocaml/.gitignore +++ b/ocaml/.gitignore @@ -1 +1,3 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: Unlicense _build diff --git a/ocaml/.ocamlformat b/ocaml/.ocamlformat index 270d50c..1cba25d 100644 --- a/ocaml/.ocamlformat +++ b/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 diff --git a/ocaml/flake.nix b/ocaml/flake.nix index 1e42610..3f9f974 100644 --- a/ocaml/flake.nix +++ b/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"; diff --git a/ocaml/justfile b/ocaml/justfile index 02aea0a..75c0a01 100644 --- a/ocaml/justfile +++ b/ocaml/justfile @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: Unlicense odig-odoc: odig odoc diff --git a/pre-commit/flake.nix b/pre-commit/flake.nix index 937f99e..baf9cb8 100644 --- a/pre-commit/flake.nix +++ b/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"; diff --git a/rust/flake.nix b/rust/flake.nix index 64cb129..df75094 100644 --- a/rust/flake.nix +++ b/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"; diff --git a/treefmt/flake.nix b/treefmt/flake.nix index 0cea4fc..c5cc5c2 100644 --- a/treefmt/flake.nix +++ b/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"; diff --git a/treefmt/treefmt.nix b/treefmt/treefmt.nix index a6d0b15..887c81c 100644 --- a/treefmt/treefmt.nix +++ b/treefmt/treefmt.nix @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2023-2025 Akira Komamura +# SPDX-License-Identifier: Unlicense { projectRootFile = "treefmt.nix"; diff --git a/zig/.gitignore b/zig/.gitignore index 629bfa1..da0e547 100644 --- a/zig/.gitignore +++ b/zig/.gitignore @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: Unlicense + # Zig zig-out/ .zig-cache/ diff --git a/zig/flake.nix b/zig/flake.nix index f5b83f6..868065f 100644 --- a/zig/flake.nix +++ b/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"; diff --git a/zig/treefmt.nix b/zig/treefmt.nix index efcea21..df9f1f2 100644 --- a/zig/treefmt.nix +++ b/zig/treefmt.nix @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: Unlicense { projectRootFile = "treefmt.nix"; From 5a59ba0c78fb29fa6fa45648faa346b62cc5f09b Mon Sep 17 00:00:00 2001 From: Akira Komamura Date: Sun, 19 Jan 2025 11:04:40 +0900 Subject: [PATCH 4/6] docs: Add MIT license identifiers --- .gitattributes | 2 ++ .gitignore | 2 ++ dev/flake.nix | 2 ++ dev/update-beam.nix | 3 +++ doc/flake.nix | 2 ++ doc/src/content/config.ts | 5 +++++ doc/treefmt.nix | 2 ++ flake.nix | 2 ++ 8 files changed, 20 insertions(+) diff --git a/.gitattributes b/.gitattributes index b047d93..735f129 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,3 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: MIT *.mdoc linguist-language=Markdown diff --git a/.gitignore b/.gitignore index 2375406..64e3dad 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2021-2025 Akira Komamura +# SPDX-License-Identifier: MIT .pre-commit-config.yaml result flake.lock diff --git a/dev/flake.nix b/dev/flake.nix index 33c55ae..a395764 100644 --- a/dev/flake.nix +++ b/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"; diff --git a/dev/update-beam.nix b/dev/update-beam.nix index 61ad72b..bc4d0a0 100644 --- a/dev/update-beam.nix +++ b/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, diff --git a/doc/flake.nix b/doc/flake.nix index c59d861..073c153 100644 --- a/doc/flake.nix +++ b/doc/flake.nix @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: MIT { inputs = { systems.url = "github:nix-systems/default"; diff --git a/doc/src/content/config.ts b/doc/src/content/config.ts index a4eec59..f0be6ea 100644 --- a/doc/src/content/config.ts +++ b/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"; diff --git a/doc/treefmt.nix b/doc/treefmt.nix index fff32f8..69ea584 100644 --- a/doc/treefmt.nix +++ b/doc/treefmt.nix @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2024-2025 Akira Komamura +# SPDX-License-Identifier: MIT { projectRootFile = "treefmt.nix"; diff --git a/flake.nix b/flake.nix index 3d8f090..7b25c55 100644 --- a/flake.nix +++ b/flake.nix @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2021-2025 Akira Komamura +# SPDX-License-Identifier: MIT { description = "A collection of project templates"; From 9245f21f04c8a05eac6bc9a09f8eabf1c481e09f Mon Sep 17 00:00:00 2001 From: Akira Komamura Date: Sun, 19 Jan 2025 11:17:32 +0900 Subject: [PATCH 5/6] docs: Add a general note on licensing --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 3ddc27e..ec529c9 100644 --- a/README.md +++ b/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: From 758905d8ad4ae0443c20a48dc8c0bdc94dc14a01 Mon Sep 17 00:00:00 2001 From: Akira Komamura Date: Sun, 19 Jan 2025 11:22:44 +0900 Subject: [PATCH 6/6] docs: Add contributing --- CONTRIBUTING.md | 14 ++++++++++++++ doc/README.md | 13 ------------- 2 files changed, 14 insertions(+), 13 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 doc/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d364be9 --- /dev/null +++ b/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. diff --git a/doc/README.md b/doc/README.md deleted file mode 100644 index 65c3de1..0000000 --- a/doc/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Documentation for Flake Templates - -This is a companion web site for -[flake-templates](https://github.com/akirak/flake-templates). - -## Contributing - -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.