|
143
by Daniel Foré
Create README.md (#11) |
1 |
# Contractor
|
2 |
||
3 |
## Building, Testing, and Installation
|
|
4 |
||
5 |
It's recommended to create a clean build environment |
|
6 |
||
7 |
mkdir build
|
|
8 |
cd build/
|
|
9 |
|
|
10 |
Run `cmake` to configure the build environment and then `make` to build
|
|
11 |
||
12 |
cmake -DCMAKE_INSTALL_PREFIX=/usr .. |
|
13 |
make |
|
14 |
||
15 |
To install, use `make install`
|
|
16 |
||
17 |
sudo make install
|
|
|
150
by Peter Uithoven
Documentation on writing contract files (#21) |
18 |
|
19 |
## Writing Contract Files
|
|
20 |
elementary Files, Photos and other apps support adding options to the context menu by the way of Contract files. |
|
21 |
||
22 |
These Contract files can be made system wide available by adding them to: |
|
23 |
`/usr/share/contractor`
|
|
24 |
or for specific users by adding them to: |
|
25 |
`~/.local/share/contractor`
|
|
26 |
||
27 |
Simple .contract file example: |
|
28 |
```
|
|
29 |
[Contractor Entry]
|
|
30 |
Name=Mount
|
|
31 |
MimeType=application/x-cd-image;application/x-raw-disk-image
|
|
32 |
Exec=gnome-disk-image-mounter %f
|
|
33 |
```
|
|
34 |
||
35 |
- `Name`: Text displayed in the right click context menu.
|
|
36 |
- `MimeType`: Mimetype(s) of files it should be shown for.
|
|
37 |
- `Exec`: Command to execute. [More info](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#exec-variables). |
|
38 |
||
39 |
Tips: |
|
40 |
- Use `pkexec` to ask for root permissions. Example: `Exec=pkexec chmod +x %U` |
|
|
151
by Peter Uithoven
Adding contract examples (#22) |
41 |
|
42 |
## Examples
|
|
43 |
- [Send by Email](https://github.com/elementary/mail/blob/master/data/mail-attach.contract) |
|
44 |
- [Print](https://github.com/elementary/pantheon-print/blob/master/data/print.contract) |
|
45 |
- [Send files via Bluetooth](https://github.com/codygarver/os-patch-gnome-bluetooth-xenial/blob/master/debian/gnome-bluetooth.contract) |
|
46 |
- [Compress](https://github.com/codygarver/os-patch-file-roller-xenial/blob/master/data/file-roller-compress.contract) |
|
47 |
- [Extract Here](https://github.com/codygarver/os-patch-file-roller-xenial/blob/master/data/file-roller-extract-here.contract) |
|
48 |
- [Write onto removable device](https://github.com/artemanufrij/imageburner/blob/master/data/com.github.artemanufrij.imageburner.contract) |
|
49 |
- [QR Share](https://github.com/mubitosh/qrshare/blob/master/data/com.github.mubitosh.qrshare.contract) |
|
50 |
- [Wallpaperize](https://github.com/Philip-Scott/wallpaperize/blob/master/data/com.github.philip-scott.wallpaperize.contract) |
|
51 |
- [Show checksum](https://github.com/artemanufrij/hashit/blob/1d295b2a340d840898999059dd808439294aa89a/data/com.github.artemanufrij.hashit.contract) |
|
|
152
by phocean
Update README.md with GPG examples (#23) |
52 |
- [GPG Encrypt/Decrypt](https://github.com/phocean/contracts-gpg) |