Add README file

This commit is contained in:
Jaidyn Ann 2024-03-03 11:30:59 -06:00
parent dae72dd72c
commit 3453641039
2 changed files with 25 additions and 0 deletions

25
README.md Normal file
View File

@ -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.
<a alt="Screenshot of Shellfox." href="res/screenshot-youtube.png"><img width=555px src="res/screenshot-youtube.png"></a>
## Installation
Shellfox uses a native program in order to run commands; installing only the add-on isnt 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, <jadedctrl@posteo.at>
License is the [GNU GPLv3](LICENSE).

BIN
res/screenshot-youtube.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB