From 9fbe944070c8f00345a53bb98e151a08023a3ca5 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Fri, 30 Jun 2017 13:17:41 -0500 Subject: [PATCH] add quick-links --- README.md | 87 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 46 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 78e6c729..caf6f88e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Bookmark Archiver [![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/thesquashSH) +▶️ [Quickstart](#quickstart) | [Details](#details) | [Configuration](#configuration) | [Manual Setup](#manual-setup) | [Troubleshooting](#troubleshooting) | [Changelog](#changelog) + + + **Supports: Browser Bookmarks (Chrome, Firefox, Safari, IE, Opera), Pocket, Pinboard, Shaarli, Delicious, Instapaper, Unmark.it, and more!** (Your own personal Way-Back Machine) [DEMO: sweeting.me/pocket](https://home.sweeting.me/pocket) @@ -41,46 +45,6 @@ You can open `service/index.html` to view your archive. (favicons will appear n If you have any trouble, see the [Troubleshooting](#troubleshooting) section at the bottom. -## Manual Setup - -If you don't like `sudo` running random setup scripts off the internet (which you shouldn't), you can follow these manual setup instructions. - -**1. Install dependencies:** `chromium >= 59`,` wget >= 1.16`, `python3 >= 3.5` (google-chrome >= v59 also works well) - -If you already have Google Chrome installed, or wish to use that instead of Chromium, follow the [Google Chrome Instructions](#google-chrome-instructions). -```bash -# On Mac: -brew cask install chromium # If you already have Google Chrome/Chromium in /Applications/, skip this command -brew install wget python3 - -echo -e '#!/bin/bash\n/Applications/Chromium.app/Contents/MacOS/Chromium "$@"' > /usr/local/bin/chromium-browser # see instructions for google-chrome below -chmod +x /usr/local/bin/chromium-browser -``` - -```bash -# On Ubuntu/Debian: -apt install chromium-browser python3 wget -``` - -```bash -# Check that everything worked: -chromium-browser --version && which wget && which python3 && which curl && echo "[√] All dependencies installed." -``` - -**2. Get your bookmark export file:** - -Follow the instruction links above in the "Quickstart" section to download your bookmarks export file. - -**3. Run the archive script:** - -1. Clone this repo `git clone https://github.com/pirate/bookmark-archiver` -3. `cd bookmark-archiver/` -4. `./archive.py ~/Downloads/bookmarks_export.html` - -You may optionally specify a third argument to `archive.py export.html [pocket|pinboard|bookmarks]` to enforce the use of a specific link parser. - -If you have any trouble, see the [Troubleshooting](#troubleshooting) section at the bottom. - ## Details `archive.py` is a script that takes a [Pocket-format](https://getpocket.com/export), [Pinboard-format](https://pinboard.in/export/), or [Netscape-format](https://msdn.microsoft.com/en-us/library/aa753582(v=vs.85).aspx) bookmark export file, and turns it into a browsable archive that you can store locally or host online. @@ -165,12 +129,53 @@ Now I can rest soundly knowing important articles and resources I like wont diss My published archive as an example: [sweeting.me/pocket](https://home.sweeting.me/pocket). -## Google Chrome Instructions: +## Manual Setup + +If you don't like `sudo` running random setup scripts off the internet (which you shouldn't), you can follow these manual setup instructions. + +**1. Install dependencies:** `chromium >= 59`,` wget >= 1.16`, `python3 >= 3.5` (google-chrome >= v59 also works well) + +If you already have Google Chrome installed, or wish to use that instead of Chromium, follow the [Google Chrome Instructions](#google-chrome-instructions). +```bash +# On Mac: +brew cask install chromium # If you already have Google Chrome/Chromium in /Applications/, skip this command +brew install wget python3 + +echo -e '#!/bin/bash\n/Applications/Chromium.app/Contents/MacOS/Chromium "$@"' > /usr/local/bin/chromium-browser # see instructions for google-chrome below +chmod +x /usr/local/bin/chromium-browser +``` + +```bash +# On Ubuntu/Debian: +apt install chromium-browser python3 wget +``` + +```bash +# Check that everything worked: +chromium-browser --version && which wget && which python3 && which curl && echo "[√] All dependencies installed." +``` + +**2. Get your bookmark export file:** + +Follow the instruction links above in the "Quickstart" section to download your bookmarks export file. + +**3. Run the archive script:** + +1. Clone this repo `git clone https://github.com/pirate/bookmark-archiver` +3. `cd bookmark-archiver/` +4. `./archive.py ~/Downloads/bookmarks_export.html` + +You may optionally specify a third argument to `archive.py export.html [pocket|pinboard|bookmarks]` to enforce the use of a specific link parser. + +If you have any trouble, see the [Troubleshooting](#troubleshooting) section at the bottom. + +### Google Chrome Instructions: I recommend Chromium instead of Google Chrome, since it's open source and doesn't send your data to Google. Chromium may have some issues rendering some sites though, so you're welcome to try Google-chrome instead. It's also easier to use Google Chrome if you already have it installed, rather than downloading Chromium all over. +1. Install & link google-chrome ```bash # On Mac: # If you already have Google Chrome in /Applications/, skip this brew command