From 8660195f7918009442b649407d19806bf9a80c95 Mon Sep 17 00:00:00 2001
From: sinanmohd <pcmsinan@gmail.com>
Date: Fri, 17 Feb 2023 19:59:54 +0530
Subject: initial commit

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..baf506b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# soibox
+A game launcher for the cmdline written in posix, soibox brings declarative game profiles to run games sandboxed
+
+## Showcase
+![soibox.gif](https://bin.sinanmohd.com/static/soibox.gif)
+
+## Installation
+```
+git clone https://git.sinanmohd.com/soibox
+cd soibox
+sudo make install
+```
+
+## Usage
+```
+soibox /path/to/game_profile
+```
+soibox comes with a [examble game profile](example/example.sb), take a look at it to make your own profiles
+
+## Dependencies
+* basic unix utils
+
+## Optional dependencies
+* [firejail](https://firejail.wordpress.com/) - sandbox games
+* [wine](https://www.winehq.org/) - run games developed for microsoft windows
+* [curl](https://github.com/curl/curl) - fetch releases from github
+* [dwarfs](https://github.com/mhx/dwarfs) - dwarfs groot support
-- 
cgit v1.2.3