remwharead/README.adoc

168 lines
4.9 KiB
Plaintext
Raw Normal View History

2019-05-11 02:52:33 +02:00
= remwharead
:toc: preamble
2019-05-11 02:52:33 +02:00
2019-09-27 03:19:04 +02:00
:project: remwharead
:uri-base: https://schlomp.space/tastytea/{project}
:uri-branch-main: {uri-base}/src/branch/main
:uri-reference: https://doc.schlomp.space/{project}/
:uri-images-base: https://doc.schlomp.space/.{project}
:uri-archive: https://archive.org/
:uri-overlay: https://schlomp.space/tastytea/overlay
2019-09-26 07:56:00 +02:00
:uri-blogpost: https://blog.tastytea.de/posts/keep-track-of-what-you-have-read-online-with-remwharead/
:uri-gcc: https://gcc.gnu.org/
:uri-clang: https://clang.llvm.org/
:uri-cmake: https://cmake.org/
:uri-poco: https://pocoproject.org/
:uri-asciidoc: http://asciidoc.org/
:uri-catch: https://github.com/catchorg/Catch2
:uri-dpkg: https://packages.qa.debian.org/dpkg
:uri-rpm: http://www.rpm.org/
:uri-ff-addon: https://addons.mozilla.org/firefox/addon/remwharead
:uri-papirus: https://github.com/PapirusDevelopmentTeam/papirus-icon-theme
2019-11-28 09:45:23 +01:00
:uri-rofi: https://github.com/davatorium/rofi
2019-12-11 23:41:12 +01:00
:uri-boost: https://www.boost.org/
:uri-clang-tidy: https://clang.llvm.org/extra/clang-tidy/
2019-05-16 13:18:16 +02:00
*remwharead* saves URIs of things you want to remember in a database along with
an URI to the archived version, the current date and time, title, description,
the full text of the page and optional tags.
2019-05-11 02:52:33 +02:00
2019-09-06 00:53:58 +02:00
The database can be filtered by time, tags and full text and exported to CSV,
AsciiDoc, JSON or RSS.
2019-05-22 09:28:12 +02:00
Archiving is done using the Wayback machine from the
{uri-archive}[Internet Archive].
2019-05-18 05:09:56 +02:00
.AsciiDoc export formatted with Asciidoctor.
2019-05-18 03:28:40 +02:00
====
[alt="Dates view", height=250, link="{uri-images-base}/example_dates.png", role=left]
image::{uri-images-base}/example_dates.png[]
[alt="Tags view", height=250, link="{uri-images-base}/example_tags.png"]
image::{uri-images-base}/example_tags.png[]
2019-05-18 03:28:40 +02:00
====
2019-05-11 02:52:33 +02:00
== Usage
2019-09-27 03:19:04 +02:00
See {uri-branch-main}/man/remwharead.1.adoc[manpage] and/or read
{uri-blogpost}[the blogpost].
2019-11-28 09:45:23 +01:00
=== With rofi
The link:{uri-rofi}[rofi] export makes integration with rofi simple. See
link:{uri-branch-main}/scripts/remwharead-rofi[scripts/remwharead-rofi] for an
example.
=== In your programs
The complete functionality is implemented in a C++ library, libremwharead. Take
a look at the {uri-reference}[reference] for more info.
2019-05-11 02:52:33 +02:00
== Install
=== Gentoo
Add my {uri-overlay}[repository] and install it from
2019-05-11 02:52:33 +02:00
there.
2019-05-13 03:44:47 +02:00
[source,zsh]
2019-05-11 02:52:33 +02:00
----
eselect repository enable tastytea
echo "www-misc/remwharead ~amd64" >> /etc/portage/package.accept_keywords/remwharead
emaint sync -r tastytea
emerge -a www-misc/remwharead
----
=== Debian and Debian based
Download the `.deb`-package from
2019-09-27 03:19:04 +02:00
{uri-base}/releases[schlomp.space] and install
with `apt install ./rewharead_*.deb`. The package works for 64 bit installations
only.
2019-05-11 02:52:33 +02:00
=== From source
==== Dependencies
* Tested OS: Linux
* C++ compiler ({uri-gcc}[gcc] 6+, {uri-clang}[clang] 6+)
2019-10-30 04:47:38 +01:00
* {uri-cmake}[cmake] (at least: 3.9)
* {uri-poco}[POCO] (tested: 1.9 / 1.7)
2019-12-11 23:41:12 +01:00
* {uri-boost}[Boost] (tested: 1.71 / 1.67)
2019-05-11 02:52:33 +02:00
* Optional:
** Manpage: {uri-asciidoc}[asciidoc] (tested: 8.6)
** Tests: {uri-catch}[catch] (tested: 2.5 / 1.2)
** DEB package: {uri-dpkg}[dpkg] (tested: 1.18)
** RPM package: {uri-rpm}[rpm-build] (tested: 4.11)
2019-05-11 02:52:33 +02:00
.Install dependencies in Debian buster.
2019-05-17 00:39:09 +02:00
====
2019-05-17 00:22:16 +02:00
[source,zsh]
----
apt-get install g++ cmake libpoco-dev asciidoc dpkg
2019-05-17 00:22:16 +02:00
----
2019-05-17 00:39:09 +02:00
====
2019-05-17 00:22:16 +02:00
2019-05-11 02:52:33 +02:00
==== Get sourcecode
===== Releases
2019-09-27 03:19:04 +02:00
Download the current release at {uri-base}/releases[schlomp.space].
2019-05-11 02:52:33 +02:00
===== Development version
2019-05-13 03:44:47 +02:00
[source,zsh]
2019-05-11 02:52:33 +02:00
----
git clone https://schlomp.space/tastytea/remwharead.git
----
==== Compile
2019-05-13 03:44:47 +02:00
[source,zsh]
2019-05-11 02:52:33 +02:00
----
mkdir build
cd build/
cmake ..
cmake --build .
----
.cmake options:
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build.
* `-DWITH_MAN=NO` to not compile the manpage.
2019-05-21 15:59:35 +02:00
* `-DWITH_TESTS=YES` to compile the tests.
2019-05-21 22:39:50 +02:00
* `-DWITH_MOZILLA=YES` to install the wrapper for the Mozilla extension.
2019-05-21 23:12:02 +02:00
* `-DMOZILLA_NMH_DIR` lets you set the directory for the Mozilla
extension wrapper. The complete path is
`${CMAKE_INSTALL_PREFIX}/${MOZILLA_NMH_DIR}`.
* `-DWITH_CLANG-TIDY=YES` to check the sourcecode with
link:{uri-clang-tidy}[clang-tidy] while compiling.
* One of:
** `-DWITH_DEB=YES` if you want to be able to generate a deb-package.
** `-DWITH_RPM=YES` if you want to be able to generate an rpm-package.
2019-05-11 02:52:33 +02:00
You can run the tests with `cd tests && ctest`. Install with `make install`,
generate binary packages with `make package`.
2019-05-11 02:52:33 +02:00
2019-05-21 15:23:08 +02:00
== Browser plugins
=== WebExtension
2019-09-27 03:19:04 +02:00
The {uri-branch-main}/browser-plugins/webextension[WebExtension] works in
Firefox and possibly other browsers with WebExtension support. You can install
it from {uri-ff-addon}/[addons.mozilla.org] or build it yourself with
`build_xpi.sh`.
2019-05-21 15:23:08 +02:00
include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]
2019-09-21 23:10:15 +02:00
2019-05-11 02:52:33 +02:00
== Copyright
The icons of the plugins are from the {uri-papirus}[Papirus icon theme] with the
license GPLv3.
2019-05-21 13:59:35 +02:00
2019-05-11 02:52:33 +02:00
----
Copyright © 2019 tastytea <tastytea@tastytea.de>.
License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
This program comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.
----