Merge pull request #66 from aprescott/initial-setup-instructions

Add some initial development setup instructions
This commit is contained in:
liliakai 2014-10-17 17:42:50 -07:00
commit 1571868520

View file

@ -7,6 +7,8 @@ This is very early stuff and exists primarily to get the crypto in place.
Getting Started with Development
================================
These steps are for **development only**.
* Clone the repo
* Open Chrome
* Go to chrome://extensions/
@ -14,6 +16,16 @@ Getting Started with Development
* Click "Load unpacked extension..."
* Point to the repo's directory
Note that for development, the TextSecure staging environment uses a self-signed certificate, which Chrome will complain is insecure. So first visit <https://textsecure-service-staging.whispersystems.org/> in your browser and allow the certificate.
Now, in the extension's options, you can register for TextSecure:
* Select "Register" under "I'm new to TextSecure".
* Enter a real phone number (Google Voice numbers work too) and country combination and choose to send an SMS. You will receive a real SMS.
* Enter the verification code you received by SMS.
You should now be able to use the extension. If you need to reset your development environment, open a browser console within the extension options page (or inspect `background.html`) and execute `localStorage.clear()` to clear out the settings.
Tests
=====
Please write tests! Our testing framework is mocha and our assertion library is