Document installation instructions

privacypass / challenge-bypass-extension

DEPRECATED - Client for Privacy Pass protocol providing unlinkable cryptographic tokens

https://privacypass.github.io

BSD 3-Clause "New" or "Revised" License

1.24k stars 190 forks source link

Document installation instructions #305

Open armfazh opened 2 years ago

armfazh commented 2 years ago

git pull origin master

npm run clean
npm run build

if you have perl and make in PATH,
then "sjcl" should build without any errors
./dist directory should exist and contain an unpacked webextension,
which you can install in your web browser for testing,
or use your web browser to pack into a self-signed extension

Originally posted by @warren-bank in https://github.com/privacypass/challenge-bypass-extension/issues/300#issuecomment-1042111590

warren-bank commented 2 years ago

quick note for context: in the issue this comment was taken from, the person i was replying to already had a local git repo cloned from github (as origin) that was behind by (at least) one commit.. which they needed to pull to fix the issue at hand; any documentation would (of course) start from scratch in a clean directory.

warren-bank commented 2 years ago

PS: somewhat (indirectly) related..

PR #283 has made some (minor) changes to the npm scripts:

"prebuild" calls "clean".. so the user doesn't have to
"clean" removes additional directories:
- /lib that is generated by the typescript compiler
- ..the others only apply to updates made by the PR and don't pertain to master (yet)
- still waiting for movement on this PR..