From 3eb76d0a66820207516c708800cfb5fb04dfc470 Mon Sep 17 00:00:00 2001 From: tiagomoraismorgado Date: Thu, 26 Oct 2017 21:54:23 +0100 Subject: [PATCH] Docs - README.md - tweaks (separators, ToC, thumbnail) ## Docs - README.md - tweaks (separators, ToC, thumbnail) **this PR does basically aim at making the the following tweaks in README.md file:** - *adding separators;* - *adding ToC (Table of Contents);* - *adding thumbnail logo;* --- **main motivation behind such:** - *improving overall document accessebility* --- --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 9e4a17b..63618b9 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,34 @@ For more info, see: * [Test Pilot Product Hypothesis Document](https://docs.google.com/document/d/1WQdHTVXROk7dYkSFluc6_hS44tqZjIrG9I-uPyzevE8/edit#) * [Shield Product Hypothesis Document](https://docs.google.com/document/d/1vMD-fH_5hGDDqNvpRZk12_RhCN2WAe4_yaBamaNdtik/edit#) +--- + +## Table of Contents (ToC) + +* [Requirements](#requirements) +* [Development](#development) +* [Development](#web-extension-development) +* [Legacy Development](#legacy-development) +* [Development Environment](#development-environment) +* [Run the `.xpi` file in an unbranded build](#run-the-xpi-file-in-an-unbranded-build) +* [Correct prefs](#correct-prefs) +* [Run the TxP experiment with `jpm`](#run-the-txp-experiment-with-jpm) +* [Building .xpi](#building-xpi) +* [Testing](#testing) +* [Distributing](#distributing) +* [Make the new verion](#make-the-new-version) +* [Publish the AMO](#publish-the-amo) +* [Publish to GitHub](#publish-to-github) +* [Links](#links) + +--- ## Requirements * node 7+ (for jpm) * Firefox 53+ +--- ## Development @@ -30,6 +52,7 @@ Since Firefox 57, this extension can now be run without any of the legacy compon This will work in other builds of Firefox however certain features won't work and you will need to manually flip preferences to enable containers. All other sections of this guide talk about using the legacy setup with jpm. +--- ## Legacy Development @@ -72,6 +95,8 @@ Change the following prefs in about:config: Check out the [Browser Toolbox](https://developer.mozilla.org/en-US/docs/Tools/Browser_Toolbox) for more information about debugging add-on code. +--- + ### Building .xpi To build a local testpilot-containers.xpi, use the plain [`jpm @@ -111,8 +136,14 @@ Finally, we also publish the release to GitHub for those followers. * Release notes: copy the output of `git log --no-merges --pretty=format:"%h %s" ..` * Attach binaries: select the signed `.xpi` file +--- + ### Links - [Licence](./LICENSE.txt) - [Contributing](./CONTRIBUTING.md) - [Code Of Conduct](./CODE_OF_CONDUCT.md) + +--- + +