diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..d831c54 --- /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 + + +## 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 |