From 56a32fbeea3c8409d7058f2bf968d22f404c1a57 Mon Sep 17 00:00:00 2001 From: Andrew Chadwick Date: Fri, 9 Jun 2017 22:04:26 +0100 Subject: [PATCH] Update README and AUTHORS. Kind of a test commit, but I also want to make the README a bit prettier. Per https://github.com/achadwick/zimsearch/issues/2#issuecomment-305195464, I'm adopting this project. Thanks for your good maintainership and original work, @dsboger! I'll try and take good care of Zimsearch. --- .gitignore | 1 + AUTHORS | 1 + README | 29 ----------------------------- README.md | 37 +++++++++++++++++++++++++++++++++++++ 4 files changed, 39 insertions(+), 29 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/.gitignore b/.gitignore index 47b9dca..6a9a30d 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ /.pydevproject /.settings/ build +*~ diff --git a/AUTHORS b/AUTHORS index d76d783..5ae2292 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1 +1,2 @@ - Davi da Silva Böger +- Andrew Chadwick diff --git a/README b/README deleted file mode 100644 index f51112f..0000000 --- a/README +++ /dev/null @@ -1,29 +0,0 @@ -# zimsearch - -Author: Davi da Silva Böger -GitHub: https://github.com/dsboger/zimsearch - -zimsearch is a simple proof-of-concept implementation of a GNOME Shell search -provider for Zim pages. - -**THIS IS VERY EARLY ALPHA SOFTWARE. USE AT YOUR OWN RISK** - -# Installation - -See INSTALL for installation instructions. - -# Usage - -Search terms typed in the GNOME Shell overview are used to lookup Zim pages -from your notebooks. Page titles are matched against the search terms and -only pages that contain all terms are shown. By default, all notebooks are -searched, but there is a plugin setting to limit search to the default notebook -only. It is also possible to limit search to a certain notebook by adding a -term preceded by a hashtag sign (#). Only notebooks whose name contains the # -term are searched. If multiple # terms are typed, all but the first one are -ignored. - -# Bugs - -Please, file bug reports or feature requests in github issue tracker. - diff --git a/README.md b/README.md new file mode 100644 index 0000000..3341b5e --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Zimsearch + +Authors: Davi da Silva Böger, Andrew Chadwick +GitHub: + +Zimsearch is a simple proof-of-concept implementation of a GNOME Shell +search provider for Zim pages. + +**THIS IS VERY EARLY ALPHA SOFTWARE. USE AT YOUR OWN RISK** + +## Installation + +See [INSTALL][] for installation instructions. + +## Usage + +Search terms typed in the GNOME Shell overview are used to look up Zim +pages from your notebooks. Page titles are matched against the search +terms and only pages that contain all the terms are shown. By default, +all notebooks are searched, but there is a plugin setting to limit the +search to the default notebook only. + +It is also possible to limit the search to a certain notebook by adding +a term preceded by a hash sign (`#`). Only notebooks whose names contain +all the `#` terms are searched. + +New pages can be created by typing a complete page title, a little like +[nvPY][]. By default the new page goes into your default notebook, but you +can select others with `#` terms as above. + +## Bugs + +Please file bug reports or feature requests in github issue tracker. + +[INSTALL]: INSTALL +[nvPY]: https://github.com/cpbotha/nvpy +