diff --git a/README.md b/README.md new file mode 100644 index 0000000..90fd73d --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# ![](res/shellfox-38.png) Shellfox + +[Shellfox](https://hak.xwx.moe/jadedctrl/shellfox) is a simple add-on for [Firefox](https://firefox.com) that allows you to run shell commands at the click of a button. + + + + +## Installation +Shellfox uses a native program in order to run commands; installing only the add-on isn’t enough. Currently, the native program has only been tested on GNU/Linux, though it is likely to work on BSDs, and potentially macOS. + +First, download the repository, either [as a ZIP](https://hak.xwx.moe/jadedctrl/shellfox/archive/master.zip) or with `$ git clone https://hak.xwx.moe/jadedctrl/shellfox`. + +Then, open a terminal and use the Makefile like so: + +``` +$ sudo make native-install +``` + +After that, you can install the add-on just fine! + + +## Source code +https://hak.xwx.moe/jadedctrl/shellfox +Author is Jaidyn Ann, +License is the [GNU GPLv3](LICENSE). diff --git a/res/screenshot-youtube.png b/res/screenshot-youtube.png new file mode 100644 index 0000000..0274532 Binary files /dev/null and b/res/screenshot-youtube.png differ