mirror of
https://github.com/goreleaser/nfpm
synced 2024-09-23 23:21:12 +02:00
docs: clarify some things
Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>
This commit is contained in:
parent
865b639da8
commit
6c0299ca51
@ -1,5 +1,7 @@
|
|||||||
# Configuration
|
# Configuration
|
||||||
|
|
||||||
|
## Reference
|
||||||
|
|
||||||
A commented out `nfpm.yaml` config file example:
|
A commented out `nfpm.yaml` config file example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -127,4 +129,4 @@ deb:
|
|||||||
Templating is not and will not be supported.
|
Templating is not and will not be supported.
|
||||||
|
|
||||||
If you really need it, you can build on top of NFPM, use `envsubst`, `jsonnet`
|
If you really need it, you can build on top of NFPM, use `envsubst`, `jsonnet`
|
||||||
or something apply it on top of it.
|
or apply some other templating on top of it.
|
||||||
|
@ -12,6 +12,21 @@ and other softwares.
|
|||||||
I wanted something that could be used as a binary and/or as a library and that
|
I wanted something that could be used as a binary and/or as a library and that
|
||||||
was really simple.
|
was really simple.
|
||||||
|
|
||||||
So I created NFPM: a simpler, 0-dependency, as-little-assumptions-as-possible alternative to fpm.
|
So I decided to create NFPM: a **simpler**, **0-dependency**,
|
||||||
|
**as-little-assumptions-as-possible** alternative to fpm.
|
||||||
|
|
||||||
|
NFPM stands for *Not FPM*.
|
||||||
|
|
||||||
|
This is a subtle way of saying it wont have all features, nor all
|
||||||
|
formats that fpm has: it is supposed to be simpler.
|
||||||
|
|
||||||
|
And that's OK!, most of us don't need all those features most of the time.
|
||||||
|
|
||||||
[fpm]: https://github.com/jordansissel/fpm
|
[fpm]: https://github.com/jordansissel/fpm
|
||||||
|
|
||||||
|
## How does it work?
|
||||||
|
|
||||||
|
You create a YAML file with the definition of what you need, run the `nfpm`
|
||||||
|
binary, and it takes care of everything.
|
||||||
|
|
||||||
|
The same config file can be used to create both the RPM and Deb packages.
|
||||||
|
Loading…
Reference in New Issue
Block a user