From 2dbe7de21c142c43736ee6d201fd45b84b1558a3 Mon Sep 17 00:00:00 2001 From: Lionel Dricot Date: Sun, 30 Jan 2022 19:23:50 +0100 Subject: [PATCH] improving documentation --- README.md | 18 +++++++++++------- offpunk.py | 3 ++- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ef5e8aa..d21326c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A command-line, text-based and offline-first Gemini and Web browser by [Ploum](https://ploum.net). -Focused on Gemini first but with text-mode support for HTTP/HTML (gopher is planned), the goal of Offpunk is to be able to synchronise your content once (a day, a week, a month) and then browse/organise it while staying disconnected. +Focused on Gemini but with support for HTTP/HTML articles, the goal of Offpunk is to be able to synchronise your content once (a day, a week, a month) and then browse/organise it while staying disconnected. Offpunk is a fork of the original [AV-98](https://tildegit.org/solderpunk/AV-98) by Solderpunk and was originally called AV-98-offline as an experimental branch. @@ -38,15 +38,18 @@ To have offpunk fetch the URL at next sync and close immediately, run: `offpunk --fetch-later URL` -## TODO +## Roadmap to 1.0 (and beyond) Known issues in the code: * NOT_FIXABLE : consider root file is always index.gmi or index.html -* TODO1: Update blackbox to reflect cache hits. -* TODO2: Implement retrieving PDF version of pages -* TODO3: Transparent privacy redirects (twitter->nitter, etc) -* TODO4: Rendering themes to allow customizing of colors ? (if any interest in the feature) +* TODO1: Easy - Update blackbox to reflect cache hits. +* TODO2: Medium - "pdf" - Implement retrieving PDF version of pages +* TODO3: Easy - Transparent privacy redirects (twitter->nitter, etc) +* TODO4: Easy - Rendering themes to allow customizing of colors ? (if any interest in the feature) +* TODO5: Medium - Support for Gopher +* TODO6: Hard - "search" - Offline search engine to search in the cache (hard, no idea on how to do that) +* TODO7: Easy - "share" - send a page by email ## More @@ -78,10 +81,11 @@ To avoid using unstable or too recent libraries, the rule of thumb is that a lib ## Features +* Built-in documentation: type `help` to get the list of command or a specific help about a command. * Offline mode to browse cached content without a connection. Requested elements are automatically fetched during the next synchronization and are added to your tour. * HTML pages are prettified to focus on content. Read without being disturbed. * Support "subscriptions" to a page. New content seen in subscribed pages are automatically added to your next tour. -* Complex bookmarks management through multiple lists and built-in edition. +* Complex bookmarks management through multiple lists, built-in edition and archiving. * Advanced navigation tools like `tour` and `mark` (as per VF-1). Unlike AV-98, tour is saved on disk accross sessions. * Ability to specify external handler programs for different MIME types (use `handler`) * Gopher proxy support (e.g. for use with diff --git a/offpunk.py b/offpunk.py index 052436f..6ec6ff9 100755 --- a/offpunk.py +++ b/offpunk.py @@ -2351,7 +2351,8 @@ If current page was not in a list, this command is similar to `add LIST`.""" - list delete $LIST : delete a list permanently (a confirmation is required) See also : - add $LIST (to add current page to list) -- move $LIST (to add current page to list while removing from all others)""" +- move $LIST (to add current page to list while removing from all others) +- archive (to remove current page from all lists while adding to archives)""" listdir = os.path.join(_DATA_DIR,"lists") os.makedirs(listdir,exist_ok=True) if not arg: