nmattia/niv
1
1
Fork 0
mirror of https://github.com/nmattia/niv.git synced 2024-09-18 19:07:19 +03:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Nicolas Mattia 2019-02-11 20:56:42 +01:00
parent e571ba0411
commit 8eee86454e
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -2,8 +2,8 @@
[![CircleCI](https://circleci.com/gh/nmattia/niv.svg?style=svg)](https://circleci.com/gh/nmattia/niv)
A tool for dealing with third-party packages in [Nix]. Read more about it in
the [usage](#usage) section.
Painless dependencies for [Nix] projects. Read more in the [use case
section](#use-cases) section below.
## Install
@ -44,10 +44,11 @@ description](#commands).
### Use cases
This covers three use cases:
This section covers common use cases:
* [Bootstrapping a Nix project](#bootstrapping-a-nix-project).
* [Tracking a different a different nixpkgs branch](#tracking-a-nixpkgs-branch).
* [Importing packages from GitHub](#importing-packages-from-github).
* [Fetching packages from custom URLs](#using-custom-urls).
#### Bootstrapping a Nix project
@ -71,9 +72,8 @@ $ tree
1 directory, 6 files
```
The files `default.nix`, `nix/default.nix` and `nix/packages.nix` are useful
defaults for any Nix project. The file `nix/sources.json` is the file used by
niv to store versions and is initialized with niv and nixpkgs:
The file `nix/sources.json` is the file used by niv to store versions and is
initialized with niv and nixpkgs:
``` json
{

12
README.tpl.md
View File

@ -2,8 +2,8 @@
[![CircleCI](https://circleci.com/gh/nmattia/niv.svg?style=svg)](https://circleci.com/gh/nmattia/niv)
A tool for dealing with third-party packages in [Nix]. Read more about it in
the [usage](#usage) section.
Painless dependencies for [Nix] projects. Read more in the [use case
section](#use-cases) section below.
## Install
@ -44,10 +44,11 @@ description](#commands).
### Use cases
This covers three use cases:
This section covers common use cases:
* [Bootstrapping a Nix project](#bootstrapping-a-nix-project).
* [Tracking a different a different nixpkgs branch](#tracking-a-nixpkgs-branch).
* [Importing packages from GitHub](#importing-packages-from-github).
* [Fetching packages from custom URLs](#using-custom-urls).
#### Bootstrapping a Nix project
@ -71,9 +72,8 @@ $ tree
1 directory, 6 files
```
The files `default.nix`, `nix/default.nix` and `nix/packages.nix` are useful
defaults for any Nix project. The file `nix/sources.json` is the file used by
niv to store versions and is initialized with niv and nixpkgs:
The file `nix/sources.json` is the file used by niv to store versions and is
initialized with niv and nixpkgs:
``` json
{