Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readme first section rewrite #132

Merged
merged 2 commits into from
Dec 13, 2023
Merged

readme first section rewrite #132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcdba2f
normalize readme whitespace
mightyiam Dec 11, 2023
f78d132
rewrite first readme section
mightyiam Dec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# NGIpkgs

[NGIpkgs](https://github.com/ngi-nix/NGIpkgs) is a collection of [Nix](https://nixos.org/) packages and services for software projects that are supported through the [Next Generation Internet](https://www.ngi.eu/) (NGI) initiative of the European Commission.
[Nix] packages, [NixOS] modules and example NixOS configurations
of software projects funded by
the [Next Generation Internet][NGI] (NGI) initiative of the European Commission

[Nix]: https://nixos.org/manual/nix
[NixOS]: https://nixos.org/manual/nixos
[NGI]: https://www.ngi.eu

## Structure of NGIpkgs

The software in NGIpkgs can be divided into two broad categories: Nix packages, and NixOS modules.

Nix packages can theoretically be built and run on any operating system that runs the Nix package manager. The output of building a Nix package is often a usable library or executable and most if not all of its dependencies. In NGIpkgs, these packages are all contained in the `pkgs` directory. For simple package definitions, we use `pkgs/by-name/<pname>/package.nix`, inspired by [Nix RFC 140](https://github.com/NixOS/rfcs/blob/c8569f6719356009204133cd00d92010889ed56d/rfcs/0140-simple-package-paths.md). Otherwise, packages are added in `pkgs/<pname>/default.nix` imported in `pkgs/default.nix`.
Nix packages can theoretically be built and run on any operating system that runs the Nix package manager. The output of building a Nix package is often a usable library or executable and most if not all of its dependencies. In NGIpkgs, these packages are all contained in the `pkgs` directory. For simple package definitions, we use `pkgs/by-name/<pname>/package.nix`, inspired by [Nix RFC 140](https://github.com/NixOS/rfcs/blob/c8569f6719356009204133cd00d92010889ed56d/rfcs/0140-simple-package-paths.md). Otherwise, packages are added in `pkgs/<pname>/default.nix` imported in `pkgs/default.nix`.

NixOS modules are components that can be easily integrated into NixOS. Usually they enrich Nix packages with configuration parameters. Many of them represent services that map to one or more systemd service(s) that are designed to, run persistently on NixOS. These modules are defined in the `modules` directory of NGIpkgs, and they are ready to be deployed to a new NixOS system (such as a container, VM, or physical machine). Templates in `configs` are a good starting point for anyone interested in using modules, and they are also used for testing.

Expand All @@ -19,7 +25,7 @@ NixOS modules are components that can be easily integrated into NixOS. Usually t
│ ├── default.nix # imports all packages that are not in `by-name`
│   └── ... # directories for packages
├── modules
│   └── ... # add module files here
│   └── ... # add module files here
├── README.md # this file
├── configs
│   ├── all-configurations.nix # import configuration files here
Expand All @@ -39,4 +45,4 @@ All packages in the main branch of NGIpkgs are automatically built by a [Hydra](

## Contributing to NGIpkgs

Please see [`CONTRIBUTING.md`](CONTRIBUTING.md)
Please see [`CONTRIBUTING.md`](CONTRIBUTING.md)
Loading