aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2022-03-25 12:25:01 -0600
committerJason A. Donenfeld <Jason@zx2c4.com>2022-03-26 00:34:39 -0600
commit211aed4fee0bf101911be7d9e53cacebc5b401c2 (patch)
tree5f21f76f087347960e7f82ae83b4c780ad105df7
parentAllow skipping crediting (diff)
downloadseedrng-211aed4fee0bf101911be7d9e53cacebc5b401c2.tar.xz
seedrng-211aed4fee0bf101911be7d9e53cacebc5b401c2.zip
Make clear that it's meant for import
This project is best included as part of openrc/util-linux/busybox etc. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4ee9423..55c6a6e 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,6 @@ SeedRNG is a simple program made for seeding the Linux kernel random number
generator from seed files. The program takes no arguments, must be run as root,
and always attempts to do something useful.
-Being a single C file, `seedrng.c`, SeedRNG is meant to be copy and pasted
-verbatim into various minimal init system projects and tweaked as needed.
-
This program is useful in light of the fact that the Linux kernel RNG cannot be
initialized from shell scripts, and new seeds cannot be safely generated from
boot time shell scripts either.
@@ -33,6 +30,11 @@ compile time. If the `SEEDRNG_SKIP_CREDIT` environment variable is set to `1`,
`true`, `yes`, or `y`, then seeds never credit the RNG, even if the seed file
is creditable.
+Being a single C file, `seedrng.c`, SeedRNG is meant to be copy and pasted
+verbatim into various minimal init system projects and tweaked as needed.
+**Please do not package this repo as a standalone program**: it is intended as
+utility code meant to be imported into existing projects instead.
+
### Building &amp; Installing
```