From e3ad0fd333fce4e6383a0abf2cfb9ce1844ad8ed Mon Sep 17 00:00:00 2001 From: 0x1eef <0x1eef@protonmail.com> Date: Wed, 22 Mar 2023 13:04:32 -0300 Subject: [PATCH] README: update --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6913c7f..7762a9b 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,28 @@ ## About portzap is a utility for staying up to date with the -[HardenedBSD ports tree](https://hardenedbsd.org). -The utility stores a transient copy of the ports tree in `/home/_portzap/ports/`. -The transient copy can be created, and updated by an unprivileged user account -who is a member of the `_portzap` group. The transient copy can then be installed -into the `/usr/ports/` directory by root. +HardenedBSD ports tree. It's designed to make it easy +for unprivileged users who are members of the `_portzap` +group to create and update a transient copy of the ports +tree, which can then be installed into the `/usr/ports/` +directory by the root user. + +Once the initial installation is done, future updates are +incremental, which means that portzap will only add or update +ports that have changed since the last update. ## Usage * `portzap clone`
- This command clones HardenedBSD's ports tree into `/home/_portzap/ports/`. + Clones HardenedBSD's ports tree into `/home/_portzap/ports/`. * `portzap pull`
- This command pulls updates into `/home/_portzap/ports/`. + Pulls updates into `/home/_portzap/ports/`. * `portzap install`
- This command should be run as root.
- The command installs `/home/_portzap/ports/` into `/usr/ports/`.
- After the first installation, future installations try to save time by being incremental. + Installs `/home/_portzap/ports/` into `/usr/ports/`.
+ After the first installation, future installations try to save time + by being incremental. Must be run by the root user. ## Install