Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
63 lines (38 sloc) 2.93 KB

RetroTxt

Source code

RetroTxt employs an open sourced license with the complete code available on GitHub. This page instructs on how to use the source in both Chrome and Firefox web browsers.

Download

Download the RetroTxt source code onto your local computer.

Either by using this GitHub link and decompress the saved RetroTxt-master.zip.

Or run the following command in a terminal.

git clone https://github.com/bengarrett/RetroTxt.git

Use on Chrome

I suggest that you create a new user profile in Chrome and use that to load and edit this WebExtension.

  1. Open a new tab and type in the address chrome://extensions
  2. In the Extensions, tab check to enable Developer Mode
  3. Click the Load unpacked extension... button
  4. Navigate to the local directory containing the RetroTxt source code and select OK

Font options selection

RetroTxt should load. The Options link allows you to configure RetroTxt styling and behaviour. You can test RetroTxt and its Options while browsing a site like Jason Scott's Top 100 Textfiles.

Use on Firefox

Firefox is locked down and doesn't permit the loading of extensions outside of the Mozilla Add-ons page.

Instead, there are two options to use the source code. Either use Mozilla's terminal tool web-ext or use Firefox Developer Edition.

The web-ext tool is the preferred method and has a dedicated web page but requires node.js. It allows you to lint, run with options or build RetroTxt in Firefox.

  1. Install node.js if needed
  2. npm install --global web-ext to install web-ext
  3. cd RetroTxt into the cloned directory
  4. web-ext run to run RetroTxt in Firefox
  5. Read more about web-ext

web-ext run example

Otherwise, if you prefer using Firefox Developer Edition.

  1. Open a new tab and type in the address about:debugging
  2. Click the Load Temporary Add-on button and navigate to the local directory containing the RetroTxt source code
  3. Open the manifest.json file to load RetroTxt

Font options selection

Now in the same tab.

  1. Type in the address about:addons
  2. Select Extensions
  3. RetroTxt should be listed there with some including Options
  4. The Options button allows you to configure RetroTxt styling and behaviour
  5. Test RetroTxt and its Options while browsing a site like Jason Scott's Top 100 Textfiles

Font options selection