README: update

This commit is contained in:
0x1eef 2023-03-22 13:04:32 -03:00
parent 873adeefcf
commit e3ad0fd333

View file

@ -1,24 +1,28 @@
## About ## About
portzap is a utility for staying up to date with the portzap is a utility for staying up to date with the
[HardenedBSD ports tree](https://hardenedbsd.org). HardenedBSD ports tree. It's designed to make it easy
The utility stores a transient copy of the ports tree in `/home/_portzap/ports/`. for unprivileged users who are members of the `_portzap`
The transient copy can be created, and updated by an unprivileged user account group to create and update a transient copy of the ports
who is a member of the `_portzap` group. The transient copy can then be installed tree, which can then be installed into the `/usr/ports/`
into the `/usr/ports/` directory by root. 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 ## Usage
* `portzap clone` <br> * `portzap clone` <br>
This command clones HardenedBSD's ports tree into `/home/_portzap/ports/`. Clones HardenedBSD's ports tree into `/home/_portzap/ports/`.
* `portzap pull` <br> * `portzap pull` <br>
This command pulls updates into `/home/_portzap/ports/`. Pulls updates into `/home/_portzap/ports/`.
* `portzap install` <br> * `portzap install` <br>
This command should be run as root. <br> Installs `/home/_portzap/ports/` into `/usr/ports/`. <br>
The command installs `/home/_portzap/ports/` into `/usr/ports/`. <br> After the first installation, future installations try to save time
After the first installation, future installations try to save time by being incremental. by being incremental. Must be run by the root user.
## Install ## Install