From 1648bafe90dac9c064d37f79138b58f53ca0698d Mon Sep 17 00:00:00 2001
From: la-ninpre <aaoth@aaoth.xyz>
Date: Wed, 3 May 2023 17:54:15 +0300
Subject: readme: actualize information

---
 README.md | 42 ++++++++++++++++++++++++++++++------------
 1 file changed, 30 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index e0aef2c..4b647f6 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,41 @@
 # openbsd ports collection
 
-here are personal and work-in-progress ports for openbsd. note that they could be
-untested or broken, use on your own risk.
+here are personal and work-in-progress ports for openbsd.
+note that they could be untested or broken, use on your own risk.
 
-## installation
+## usage
 
-make sure your port build user is in `wsrc` group.
+make sure to check out the ports tree from openbsd.
 
+[openbsd faq page on ports](https://www.openbsd.org/faq/ports/ports.html#PortsFetch)
+
+then, clone this repo to `/usr/ports/mystuff/`.
+
+``` sh
+git clone https://git.aaoth.xyz/la-ninpre/ports /usr/ports/mystuff
 ```
-# umask 002; mkdir /usr/ports-laninpre
-# chgrp wsrc /usr/ports-laninpre
-# echo PORTSDIR_PATH=/usr/ports:/usr/ports/mystuff:/usr/ports-laninpre >> /etc/mk.conf
-# exit
-
-$ git clone https://git.aaoth.xyz/ports.git /usr/ports-laninpre
-$ cd /usr/ports-laninpre
-$ ...
+
+then build ports as usual (e.g. `cd /usr/ports/mystuff/<category>/<port> && make && make install`).
+
+**NOTE**: ports from this repo create additional unprivileged users.
+users needed for ports need to be specified in `/usr/ports/infrastructure/db/user.list`.
+users for this repo are not approved by openbsd team (yet),
+so they won't be there, you'll have to add them yourself.
+
+here's a list of current users:
+
+``` user.list
+1100 _forgejo			_forgejo		www/forgejo
+1101 _gatus				_gatus			www/gatus
+1102 _inks				_inks			www/inks
+1103 _alfis				_alfis			net/alfis
+1104 _matterbridge		_matterbridge	net/matterbridge
+1105 _owncast			_owncast		www/owncast
 ```
 
+i choose to use uids and gids higher than 1000
+so that they won't collide with other ports.
+
 ## contact
 
 `aaoth at aaoth dot xyz`
-- 
cgit v1.2.3