nixos/templates
1
0
Fork 0
mirror of https://github.com/NixOS/templates.git synced 2026-01-13 09:48:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
Flake templates
58 commits 3 branches 0 tags 321 KiB
Find a file
asymmetric d7a340cfe1
trivial: change default package format after 2.7.0 
See https://discourse.nixos.org/t/nix-2-7-0-released/18072
2022-03-26 08:55:09 +00:00
.github Initial work on README.md 2022-01-25 12:00:01 +01:00
bash-hello attribute self.lastModifiedDate missing in newer versions of flakes 2022-01-27 01:36:03 +01:00
c-hello Merge pull request #4 from L-as/master 2021-11-19 16:01:15 +03:00
compat Add a template that provides default.nix and shell.nix 2021-08-02 16:23:35 +02:00
full full: flake config for bundlers.* changed (#27) 2022-03-09 21:12:19 -05:00
go-hello go: inital example using buildGoModule 2022-01-21 02:42:34 -05:00
haskell-hello typo 2021-11-05 14:50:53 +01:00
hercules-ci templates/hercules-ci: init 2021-12-11 22:17:32 +00:00
pandoc-xelatex better formatting for abstract 2022-01-14 17:39:30 +01:00
python added rust and python templates 2021-03-10 06:50:35 +03:00
rust templates/rust: fix mkApp call 2021-11-22 10:38:32 +01:00
rust-web-server correct spelling numer -> number 2021-10-19 21:47:41 +01:00
simple-container Doh 2020-06-23 16:14:28 +02:00
trivial trivial: change default package format after 2.7.0 2022-03-26 08:55:09 +00:00
COPYING Initial work on README.md 2022-01-25 12:00:01 +01:00
flake.nix full: flake config for bundlers.* changed (#27) 2022-03-09 21:12:19 -05:00
README.md Update README.md 2022-01-25 14:59:53 +01:00

README.md

Official Nix templates

Templates are there to help you start your Nix project.

$ nix flake init --template templates#full

or

$ nix flake new --template templates#full ./my-new-project

Each template ships with a tutorial (README.md) which explains in details how to use it and extend it.

How to contribute

Main purpose of this repository is to collect most common templates to help newcomers learn Nix. For this purpose the collection of templates is limited to provided an opinionated and curated list.

Other templates for more advanced topics can be found in nix-community/templates.

TODO: templates should be also discoverable on search.nixos.org

Opening issues

What is required to submit a template?

Each template needs:

  • name

    Folder with the same name should be created and this is a location of the template. An entry with name is requred in flake.nix.

  • description

    A description that explains the content of the template in one sentence. An entry with description is requred in flake.nix.

  • maintainers

    Each template needs one of more maintainers with the knowledge of specific area. Each template has an entry in .github/CODEOWNERS with maintainers next to them.

  • tutorial

    Tutorial showing the usage of the template should be placed in README.md.

License

Note: contributing implies licensing those contributions under the terms of COPYING, which is the MIT license.