From 6c0299ca5151be761e7293286e212445d7815609 Mon Sep 17 00:00:00 2001 From: Carlos Alexandro Becker Date: Fri, 10 Jul 2020 02:16:16 -0300 Subject: [PATCH] docs: clarify some things Signed-off-by: Carlos Alexandro Becker --- www/docs/configuration.md | 4 +++- www/docs/index.md | 17 ++++++++++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/www/docs/configuration.md b/www/docs/configuration.md index c08e042..3e49344 100644 --- a/www/docs/configuration.md +++ b/www/docs/configuration.md @@ -1,5 +1,7 @@ # Configuration +## Reference + A commented out `nfpm.yaml` config file example: ```yaml @@ -127,4 +129,4 @@ deb: Templating is not and will not be supported. 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. diff --git a/www/docs/index.md b/www/docs/index.md index bb4dca6..b2a2ac8 100644 --- a/www/docs/index.md +++ b/www/docs/index.md @@ -12,6 +12,21 @@ and other softwares. I wanted something that could be used as a binary and/or as a library and that 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 + +## 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.