From 080e11de5c73b45893ff09d94383217ac02309f3 Mon Sep 17 00:00:00 2001 From: NateN1222 Date: Sun, 8 Oct 2017 12:49:06 -0500 Subject: changed readme --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 16bd675..4c61759 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,22 @@ Porting LibreJS to webExtensions -It is lacking some license information for the assets from the original LibreJS. Also, not sure what license should be used for the new source files. +It is lacking some license information for the assets from the original LibreJS. Not sure what license should be used for the new source files either. Also, we probably want to sort out the licenses for the dependencies (Acorn Javascript parser and jsSHA) to make sure they are cited correctly. -This cannot be finished right now because a required webExtensions API feature is not implemented yet. (see https://bugzilla.mozilla.org/show_bug.cgi?id=1255894) +TO BUILD: + +First, you need to get some stuff with npm: + +npm install acorn +npm install jssha +npm install browserify + +To build the extension run this: + +browserify main_background.js -o bundle.js + +To debug this add-on on Firefox or Icecat, go to the special URL "about:debugging", enable add-on debugging load the manifest.json. + +Chrome should work eventually but I haven't tested it lately. To debug the add-on on Chrome it's basically the same except you load it from "chrome://extensions" Mailing list: bug-librejs@gnu.org -- cgit v1.2.3