From e00fd49bc0b6801a008f8e9c54877e5fedd7ccf7 Mon Sep 17 00:00:00 2001
From: JozanLeClerc <JozanLeClerc@noemail.net>
Date: Sun, 29 Nov 2020 18:15:45 +0000
Subject: Added README

FossilOrigin-Name: 8134fb7bb5cf97857fdfc47e514aa445a5a9efb3
---
 README.org | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 8529ca7..afff15f 100644
--- a/README.org
+++ b/README.org
@@ -1,4 +1,49 @@
 #+TITLE: bsdsetsid
 
 Simple implementation of util-linux *setsid* for FreeBSD. This was not tested
-on other BSD's or macOS but this might work just fine.
+on other BSD's or macOS but this probably works just fine.
+
+* Dependencies
+- A C compiler
+- BSD Make
+
+* Installation
+You can get *bsdsetsid* either through ~git~ or ~fossil~.
+
+For ~fossil~ use:
+#+BEGIN_SRC shell
+mkdir bsdsetsid
+cd bsdsetsid
+fossil clone \
+  https://chiselapp.com/user/JozanLeClerc/repository/bsdsetsid \
+  bsdsetsid.fossil
+fossil open --force bsdsetsid.fossil
+#+END_SRC
+or for ~git~:
+#+BEGIN_SRC shell
+git clone git://jozanleclerc.xyz/jozan/bsdsetsid.git
+cd bsdsetsid
+#+END_SRC
+Then build and install the program:
+#+BEGIN_SRC shell
+make
+sudo make install clean
+#+END_SRC
+Note that if you are one macOS, you need to install and use BSD Make instead
+of GNU Make.
+
+* Usage
+Example of usage:
+#+BEGIN_SRC shell
+bsdsetsid st -e sh -c 'cowsay hello; zsh -i'
+exit
+#+END_SRC
+Replace ~st~ and other arguments with any program you'd like to run detached
+from the current shell.
+
+For more informations, run:
+#+BEGIN_SRC shell
+man bsdsetsid
+#+END_SRC
+
+Thanks for checking *bsdsetsid*.
-- 
cgit v1.2.3