enhance README
This commit is contained in:
parent
f6252040f9
commit
1ca79e47c4
14
README.md
14
README.md
|
@ -1,4 +1,12 @@
|
|||
# nixpkgs-mirror-tarballs
|
||||
# Introduction
|
||||
|
||||
The point of this script is to allow users to locally download all sources required to build a given Nix package.
|
||||
|
||||
The script relies on internal Nixpkgs tools that will download the sources in the nix store and verify the checksum.
|
||||
|
||||
If you run it multiple times, nothing more will be downloaded but it takes a bit of time to ensure each file is in the store.
|
||||
|
||||
# how to use
|
||||
|
||||
To download sources required to build `git` and `kakoune`:
|
||||
```
|
||||
|
@ -9,3 +17,7 @@ If you want to use a different nixpkgs version than the one in your system:
|
|||
```
|
||||
./run.sh -f ~/path/to/nixpkgs/ git kakoune
|
||||
```
|
||||
|
||||
# BUGS
|
||||
|
||||
This requires https://github.com/NixOS/nixpkgs/pull/188626 to be merged
|
||||
|
|
Loading…
Reference in New Issue