Merge pull request #1 from hercules-ci/domenkozar-patch-1

Small changes to README
This commit is contained in:
Robert Hensing 2019-05-13 09:18:38 +02:00 committed by GitHub
commit 4346ae219b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,9 +1,19 @@
# `gitignore` for Nix that just works
This project lets you include local sources in your [Nix](https://builtwithnix.org) projects, while taking [gitignore files](https://git-scm.com/docs/gitignore) into account.
This project lets you include local sources in your [Nix](https://builtwithnix.org) projects,
while taking [gitignore files](https://git-scm.com/docs/gitignore) into account.
# 'Installation'
# Installation
## Recommended with Niv
```
nix-env -iA niv -f https://github.com/nmattia/niv/tarball/master
niv init
niv add hercules-ci/gitignore
```
## Plain Nix way
```nix
let
@ -20,12 +30,6 @@ in
<your nix expression>
```
or
```
niv add hercules-ci/gitignore
```
# Usage
```nix
@ -38,9 +42,9 @@ mkDerivation {
# Features
- Subdirectories just work
- Hashes only change when output changes
- Source hashes only change when output changes
- Not impacted by large or inaccessible ignored directories
- Composes with cleanSourceWith
- Composes with `cleanSourceWith`
- Reads user git configuration; no need to bother your team with your tool config.
- Also works with restrict-eval enabled (if avoiding `fetchFromGitHub`)
- No import from derivation ("IFD")