Tweak README phrasing
This commit is contained in:
parent
960c8899dc
commit
3a8e987931
21
README.md
21
README.md
|
@ -6,22 +6,37 @@
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## 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.
|
Shellfox has two components: A Firefox extension, and a native script that the extension uses to run commands.
|
||||||
|
|
||||||
|
You can install the Firefox extension from [Firefox Add-ons (AMO)](https://addons.mozilla.org/en-US/firefox/addon/shellfox).
|
||||||
|
|
||||||
|
The native script has only been tested on GNU/Linux, though it is likely to work on BSDs, and potentially macOS. It can be installed like so:
|
||||||
|
|
||||||
First, download the repository: [shellfox.zip](https://hak.xwx.moe/jadedctrl/shellfox/archive/master.zip)
|
First, download the repository: [shellfox.zip](https://hak.xwx.moe/jadedctrl/shellfox/archive/master.zip)
|
||||||
|
|
||||||
Then, in the repository’s directory, open a terminal and run:
|
Then, extract the repository’s ZIP file. Enter the unpacked `shellfox/` folder and, from a terminal, run:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ sudo make native-install
|
$ sudo make native-install
|
||||||
```
|
```
|
||||||
|
|
||||||
After that, you can install the add-on; then, voilà!
|
After that, make sure you have [the extension](https://addons.mozilla.org/en-US/firefox/addon/shellfox) installed; then, voilà!
|
||||||
|
|
||||||
|
|
||||||
|
### From terminal
|
||||||
|
To install solely using your terminal:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ curl https://hak.xwx.moe/jadedctrl/shellfox/archive/master.tar.gz | tar -xzv
|
||||||
|
$ cd shellfox/
|
||||||
|
$ sudo make native-install
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Related projects
|
## Related projects
|
||||||
This add-on was inspired by [Textern](https://github.com/jlebon/textern/), which allows you to edit text-boxes with an external editor like [Emacs](https://gnu.org/software/emacs). It’s very useful, I highly recommend it!
|
This add-on was inspired by [Textern](https://github.com/jlebon/textern/), which allows you to edit text-boxes with an external editor like [Emacs](https://gnu.org/software/emacs). It’s very useful, I highly recommend it!
|
||||||
|
|
||||||
|
|
||||||
## Source code
|
## Source code
|
||||||
https://hak.xwx.moe/jadedctrl/shellfox
|
https://hak.xwx.moe/jadedctrl/shellfox
|
||||||
Author is Jaidyn Ann, <jadedctrl@posteo.at>
|
Author is Jaidyn Ann, <jadedctrl@posteo.at>
|
||||||
|
|
Ŝarĝante…
Reference in New Issue