From 27e9785a91925bc27d6bc92d69086e43bac93282 Mon Sep 17 00:00:00 2001 From: "sashakoshka@tebibyte.media" Date: Wed, 9 Oct 2024 20:27:35 -0400 Subject: [PATCH] Better setup instructions in README --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 311173a..fa3e52c 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,20 @@ messages using the "bulb" command. You can also set up multiple boards. ## Setup +You can install the `bulb` command by running: + +``` +hare build cmd/bulb +``` + +And then installing the resulting executable. + The reccomended way to use this program is to have the executable owned by the -user `bulb`, with the setuid bit enabled. Then, create a list of boards located -at `/var/bulb/` which are also owned by `bulb`. This will allow all users to use -the program to post on boards without allowing them to directly edit their -contents, thereby preventing them from mischeviously re-writing chat history. +user `bulb`, with the setuid bit enabled. Then, create a list of boards (empty +text files) located at `/var/bulb/` which are also owned by `bulb`. This will +allow all users to use the program to post on boards without allowing them to +directly edit their contents, thereby preventing them from mischeviously +re-writing chat history. ## Usage