Added README

FossilOrigin-Name: 8134fb7bb5cf97857fdfc47e514aa445a5a9efb3

3 files changed, 166 insertions, 1 deletions

diff --git a/README b/README
index e69de29..c917abc 100644
--- a/README
+++ b/README
@@ -0,0 +1,46 @@
+bsdsetsid
+---------
+
+Simple implementation of util-linux *setsid* for FreeBSD. This was not tested
+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:
+  $ mkdir bsdsetsid
+  $ cd bsdsetsid
+  $ fossil clone \
+    https://chiselapp.com/user/JozanLeClerc/repository/bsdsetsid \
+    bsdsetsid.fossil
+  $ fossil open --force bsdsetsid.fossil
+
+or for git:
+  $ git clone git://jozanleclerc.xyz/jozan/bsdsetsid.git
+  $ cd bsdsetsid
+
+Then build and install the program:
+  $ make
+  $ sudo make install clean
+
+Note that if you are one macOS, you need to install and use BSD Make instead
+of GNU Make.
+
+Usage
+-----
+Example of usage:
+  $ bsdsetsid st -e sh -c 'cowsay hello; zsh -i'
+  $ exit
+Replace st and other arguments with any program you'd like to run detached from
+the current shell.
+
+For more informations, run:
+  $ man bsdsetsid
+
+Thanks for checking bsdsetsid.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..36f2775
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+
+# Table of Contents
+
+1.  [Dependencies](#orgfb13261)
+2.  [Installation](#org4f42ed6)
+3.  [Usage](#orgcad236a)
+
+Simple implementation of util-linux **setsid** for FreeBSD. This was not tested
+on other BSD's or macOS but this probably works just fine.
+
+
+<a id="orgfb13261"></a>
+
+# Dependencies
+
+-   A C compiler
+-   BSD Make
+
+
+<a id="org4f42ed6"></a>
+
+# Installation
+
+You can get **bsdsetsid** either through `git` or `fossil`.
+
+For `fossil` use:
+
+```sh
+mkdir bsdsetsid
+cd bsdsetsid
+fossil clone https://chiselapp.com/user/JozanLeClerc/repository/bsdsetsid bsdsetsid.fossil
+fossil open --force bsdsetsid.fossil
+```
+
+or for `git`:
+
+```sh
+git clone git://jozanleclerc.xyz/jozan/bsdsetsid.git
+cd bsdsetsid
+```
+
+Then build and install the program:
+
+```sh
+make
+sudo make install clean
+```
+
+Note that if you are one macOS, you need to install and use BSD Make instead
+of GNU Make.
+
+
+<a id="orgcad236a"></a>
+
+# Usage
+
+Example of usage:
+
+```sh
+bsdsetsid st -e sh -c 'cowsay hello; zsh -i'
+exit
+```
+
+Replace `st` and its arguments with any program you'd like to run detached
+from the current shell.
+
+For more informations, run:
+
+```sh
+man bsdsetsid
+```
+
+Thanks for checking **bsdsetsid**.
+
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*.