From 4d6ec5479f6e4406532e732b95defa639967d3de Mon Sep 17 00:00:00 2001 From: ccd0 Date: Sun, 5 Jul 2015 19:41:05 -0700 Subject: [PATCH] Reorganize README.md. --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index f231ae824..24f1fa8c5 100755 --- a/README.md +++ b/README.md @@ -6,33 +6,26 @@ Previously developed by [aeosynth](https://github.com/aeosynth/4chan-x), [Mayhem If you're looking for a maintained fork of OneeChan (a style script used in addition to 4chan X), try https://github.com/Nebukazar/OneeChan. -## Firefox version: [Click to Install](https://ccd0.github.io/4chan-x/builds/4chan-X.user.js) -Install [Greasemonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/), then click the link above to install 4chan X. +## Firefox +Install [Greasemonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/), then **[click here to install 4chan X](https://ccd0.github.io/4chan-x/builds/4chan-X.user.js)**. -Pale Moon users should use [Greasemonkey 1.15](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/versions/#version-1.15.1-signed). SeaMonkey users should use Greasemonkey 2.3 converted with [this tool](http://addonconverter.fotokraina.com/?url=https://addons.mozilla.org/firefox/downloads/file/282084/greasemonkey-2.3-fx.xpi). +- **Pale Moon** users should use [Greasemonkey 1.15](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/versions/#version-1.15.1-signed). +- **SeaMonkey** users should use Greasemonkey 2.3 converted with [this tool](http://addonconverter.fotokraina.com/?url=https://addons.mozilla.org/firefox/downloads/file/282084/greasemonkey-2.3-fx.xpi). -**WARNING**: -If you're switching to this fork from someone else's fork of 4chan X, back up your old script before installing this one as the old one may be overwritten. +## Chromium +4chan X is available as a Chrome extension. The Chrome extension has the additional feature of being able to sync your settings and data with other devices via Chrome Sync. -**Known issues**: -Greasemonkey 3.0 has a [bug](https://github.com/greasemonkey/greasemonkey/issues/2094) causing 4chan X to open multiple tabs when you open a new tab (for example, when starting a thread). If you're having this problem, [updating](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/) to Greasemonkey 3.1 or later should fix it. +- **Chromium**, **Chrome**, and **Vivaldi** users can **[install 4chan X from the Chrome store](https://chrome.google.com/webstore/detail/4chan-x/ohnjgmpcibpbafdlkimncjhflgedgpam)**. +- **Chromium** users can alternately **[download 4chan X from Github](https://ccd0.github.io/4chan-x/builds/4chan-X.crx)**, then drag it to your `chrome://extensions` page. This will also work for Chrome dev/canary, and Chrome on platforms other than Windows. +- **Opera** users can click to **[download 4chan X from Github](https://ccd0.github.io/4chan-x/builds/4chan-X.crx)**, then follow the prompts to activate it in your extension manager. Note: This version does not work with Presto-based Opera; try [loadletter's fork](https://github.com/loadletter/4chan-x) instead. -## Chromium version: [Click to Install](https://ccd0.github.io/4chan-x/builds/4chan-X.crx) -Download the file from the link above and add drag it to your `chrome://extensions` page. -This should also work for Opera 21+, Chrome dev/canary, and Chrome on platforms other than Windows. +It is also possible to use the [userscript version of 4chan X](https://ccd0.github.io/4chan-x/builds/4chan-X.user.js) with [Tampermonkey](https://tampermonkey.net/). -**The above will not work in Chrome (stable or beta) on Windows; you must install from the [Chrome store](https://chrome.google.com/webstore/detail/4chan-x/ohnjgmpcibpbafdlkimncjhflgedgpam) as described below.** +## Safari +Install [JS Blocker](http://jsblocker.toggleable.com/), then **[click here to install 4chan X](https://ccd0.github.io/4chan-x/builds/4chan-X.user.js)**. -## Chromium version (Chrome store): [Click to Install](https://chrome.google.com/webstore/detail/4chan-x/ohnjgmpcibpbafdlkimncjhflgedgpam) -The stable and beta releases of Chrome on Windows will disable extensions not installed from the Chrome store, so users will need to install 4chan X from the link above. -Only the latest stable version of 4chan X is available. - -## Other browsers -4chan X can be used in other browsers, but not all features will work, and you should expect some bugs. In addition, I don't regularly test in these browsers, so updates may occasionally break the script. If this happens, [open an issue](https://github.com/ccd0/4chan-x/issues), and use an old version from the [changelog](https://github.com/ccd0/4chan-x/blob/master/CHANGELOG.md) until it's fixed. You can also try [loadletter's fork](https://github.com/loadletter/4chan-x) if you're having trouble getting this one to work. - -Browsers using WebKitGTK+ (dwb, Midori, Luakit, uzbl) may crash when repeatedly solving the default image-based captchas. You can avoid this problem by enabling `Use Recaptcha v1` in your settings. - -- **Safari**: Install [JS Blocker](http://jsblocker.toggleable.com/), then click the link to the [script](https://ccd0.github.io/4chan-x/builds/4chan-X.user.js) to install it. +## WebKitGTK+ +Several WebKitGTK+ based browsers have support for userscripts and can run 4chan X. Due to the lack of the cross-site GM_* API, and lack of support for userscripts in iframes, not all features will work. You may experience crashes when repeatedly solving the default image-based captchas. You can avoid this problem by enabling `Use Recaptcha v1` in your settings. - **dwb**: Install the userscripts extension, then save the [script](https://ccd0.github.io/4chan-x/builds/4chan-X.user.js) to the `$XDG_CONFIG_HOME/dwb/greasemonkey` or `$HOME/.config/dwb/greasemonkey` directory (creating it if necessary): @@ -53,14 +46,21 @@ Browsers using WebKitGTK+ (dwb, Midori, Luakit, uzbl) may crash when repeatedly ## Beta version New features and non-urgent bugfixes are released on the beta channel for further testing before they are moved the stable version. Please [report](https://github.com/ccd0/4chan-x/issues) any issues you find, and be sure to mention which version you're using. You should back up your settings regularly to prevent them from being lost due to bugs. -- [Firefox version](https://ccd0.github.io/4chan-x/builds/4chan-X-beta.user.js) -- [Chromium version](https://ccd0.github.io/4chan-x/builds/4chan-X-beta.crx) -If you want to install the current beta version but get updates from the stable channel after that, install it from [here](https://github.com/ccd0/4chan-x/raw/beta/builds/4chan-X.user.js) for Firefox or [here](https://github.com/ccd0/4chan-x/raw/beta/builds/4chan-X.crx) for Chromium. +To install the current **beta** version but get updates from the **stable** channel (recommended if you want a particular recent feature): +- [Install userscript](https://github.com/ccd0/4chan-x/raw/beta/builds/4chan-X.user.js) (use with Greasemonkey / Tampermonkey / JS Blocker / etc.) +- [Download Chrome extension](https://github.com/ccd0/4chan-x/raw/beta/builds/4chan-X.crx) (download and drag to `chrome://extensions`) + +To install the **beta** version and get updates whenever there's a new **beta** version: +- [Install userscript](https://ccd0.github.io/4chan-x/builds/4chan-X-beta.user.js) +- [Download Chrome extension](https://ccd0.github.io/4chan-x/builds/4chan-X-beta.crx) ## Security note 4chan X currently shares your settings and post history between the HTTP and HTTPS versions of 4chan. If you are concerned about protecting your privacy against a man-in-the-middle attack, you should disable 4chan X on the HTTP version of 4chan and/or install [HTTPS Everywhere](https://www.eff.org/https-everywhere). +## Troubleshooting +If you encounter a bug, try the steps [here](https://github.com/ccd0/4chan-x/blob/master/CONTRIBUTING.md#reporting-bugs), then report it to the [issue tracker](https://github.com/ccd0/4chan-x/issues). If the bug seems to be caused by a script update, you can install a old version from the [changelog](https://github.com/ccd0/4chan-x/blob/master/CHANGELOG.md). + ## Uninstalling 4chan X disables the native extension, so if you uninstall 4chan X, you'll need to re-enable it. To do this, click the `[Settings]` link in the top right corner and uncheck "`Disable the native extension`" in the panel that appears.