Browse Source

Update doc files.

Add more information to the README and update the NEWS file for
the upcoming release.
master yorkie-0.2.0
parent
commit
0560a1e9f4
  1. 8
      NEWS
  2. 36
      README.md

8
NEWS

@ -1,2 +1,6 @@
Changes in yorkie 0.2.0
-----------------------
Changes in yorkie 0.2.0 (2020-05-10)
------------------------------------
* Implement the decrypt/verify task.
* Partial support for verification of detached signatures.
* Display error messages in a graphical dialog box.

36
README.md

@ -27,8 +27,44 @@ Yorkie depends on the following libraries:
the graphical user interface.
Usage
-----
To encrypt and/or sign a file, call `yki` with the `-e` option (or no
option at all, as encrypt/sign is the default operation) and the
pathname to the file to encrypt and/or sign. In the dialog that will pop
up, select the settings you want, then click OK to proceed.
To decrypt and/or verify a file, call `yki` with the `-d` option and the
pathname to the file to decrypt and/or verify. The program will process
the file and display the result of the decryption/verification in a
dialog box. Click OK to actually write the decrypted or verified data to
a new file.
If the file to verify is a *detached signature*, Yorkie will assume the
corresponding signed data is contained in a file within the same
directory and with the same name minus a `.asc`, `.gpg`, or `.sig`
extension.
Integration with DES-EMA-compliant file managers
------------------------------------------------
Yorkie comes with two `.desktop` files, installed under the
`$prefix/share/yorkie` directory, to enable calling Yorkie from the
context menu of file managers compliant with the DES-EMA specification
(e.g., LibFM-based file managers such as
[PCManFM](https://wiki.lxde.org/en/PCManFM). Copy these files to your
`$XDG_DATA_HOME/file-manager/actions` directory for your file manager to
use them.
Copying
-------
Yorkie is distributed under the terms of the GNU General Public
License, version 3 or higher. The full license is included in the
[COPYING file](COPYING) of the source distribution.
Homepage and repository
-----------------------
The project is located at https://incenp.org/dvlpt/yorkie.html. The
latest source code is available at https://git.incenp.org/damien/yorkie.

Loading…
Cancel
Save