Skip to content

Commit

Permalink
Rewrite README as markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
toobaz committed Dec 30, 2020
1 parent d5b1996 commit 727154d
Showing 1 changed file with 32 additions and 23 deletions.
55 changes: 32 additions & 23 deletions README
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
===== What is this? =====
## What is this?

Crypto is a simple plugin for the gedit
( http://projects.gnome.org/gedit/ ) editor, allowing you to quickly
encrypt/decrypt text documents with GPG.

Crypto is a simple plugin for the [gedit]( http://projects.gnome.org/gedit/ )
editor, allowing you to quickly encrypt/decrypt text documents with GPG.

Once installed and activated (through the "Preferences" window, "Plugin" tab),
it will add a submenu to the "Gear" menu, with two options allowing you to
Expand All @@ -11,45 +11,54 @@ encrypt or decrypt the currently open document.
Notice that to encrypt/decrypt, you should have already set up your key using
gpg or seahorse.

===== How to install? =====
### How to install?


If you are a user of Debian (or any derivative such as Ubuntu or Mint),
the simplest way is to download and install the .deb package above.

Otherwise, to install for a single user, extract the archive and then:

cd gedit-plugin-crypto-*
ln -s crypto.plugin ~/.local/share/gedit/plugins/crypto.plugin
ln -s crypto ~/.local/share/gedit/plugins/crypto
```python
cd gedit-plugin-crypto-*
mkdir -p ~/.local/share/gedit/plugins/
ln -s `pwd`/crypto.plugin ~/.local/share/gedit/plugins/crypto.plugin
ln -s `pwd`/crypto ~/.local/share/gedit/plugins/crypto
```

To install systemwise (as root):

cd gedit-plugin-crypto-*
ln -s crypto.plugin /usr/lib/gedit/plugins/crypto.plugin
ln -s crypto /usr/lib/gedit/plugins/crypto
mkdir /usr/share/gedit/plugins/crypto
ln -s crypto/crypto.glade /usr/share/gedit/plugins/crypto/crypto.glade
```python
cd gedit-plugin-crypto-*
ln -s `pwd`/crypto.plugin /usr/lib/gedit/plugins/crypto.plugin
ln -s `pwd`/crypto /usr/lib/gedit/plugins/crypto
mkdir /usr/share/gedit/plugins/crypto
ln -s `pwd`/crypto/crypto.glade /usr/share/gedit/plugins/crypto/crypto.glade
```

===== Who should I blame if this sucks? =====
### Who should I blame if this sucks?

Pietro Battiston - <me@pietrobattiston.it>

===== Technicalities =====
### Technicalities

This plugin relies on the Seahorse ( https://projects.gnome.org/seahorse/ ) dbus
This plugin relies on the [Seahorse](https://projects.gnome.org/seahorse) dbus
service, which does the real work.

===== Requirements =====
### Requirements

Gedit version 3 or later and the Seahorse daemon must be installed for the plugin to work.
Gedit version 3 or later and the Seahorse daemon (package ``seahorse-daemon``
on debian-based systems) must be installed for the plugin to work.

In particular, current versions need gedit 3.12 or later; if you're using a previous version of gedit,
{{:gedit-crypto:gedit-plugin-crypto-0.3.tar.gz|download version 0.3 of gedit-crypto.}}
In particular, current versions need gedit 3.12 or later; if you're using a
previous version of gedit,
[download version 0.3 of gedit-crypto](https://pietrobattiston.it/wiki/_media/gedit-crypto:gedit-plugin-crypto-0.3.tar.gz).

If your version of gedit is even older than 3.8, you need {{:gedit-crypto:gedit-plugin-crypto-0.2.tar.gz|version 0.2 of gedit-crypto.}}
If your version of gedit is even older than 3.8, you need
[version 0.2 of gedit-crypto](https://pietrobattiston.it/wiki/_media/gedit-crypto:gedit-plugin-crypto-0.2.tar.gz).

===== Code =====
### Code

You can browse/clone/fork the git repo at
[[https://github.com/toobaz/gedit_crypto ]] . I'm willing to integrate
https://github.com/toobaz/gedit_crypto . I'm willing to integrate
enhancements/bug fixes, so feel free to open PRs.

0 comments on commit 727154d

Please sign in to comment.