Merge pull request #255 from aspiers/dev-build

Document how to build from source

Author: yangbrian310

README.md

@@ -77,13 +77,18 @@ To get started, install the Reactime [extension](https://chrome.google.com/webst
 
 NOTE: The React Developer Tools [extension](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) is also required for Reactime to run, if you do not already have it installed on your browser.
 
-### <b>Alternative Installation</b>
+### Installation
 
 Go to Chrome Extensions (make sure Chrome Extension is in Developer Mode) for manual installation in (https://developer.chrome.com/extensions/faq#faq-dev-01) and click on Load Unpacked. Use `src/extension/build/` to load this extension. Turn on 'Allow access to file URLs' in extension details page if testing locally.
 
 <i>Please refer to Developer Install for a detailed guide:</i>
 <a href='/DeveloperREADME.md'>Developer Install</a> 
 
+### Building from source
+
+Please see [the developer README](src/README.md) for instructions on building
+from source.
+
 ## <b>How to Use</b>
 
 After installing the Chrome extension, just open up your project in the browser.

src/README.md

@@ -3,6 +3,18 @@
 ## Brief
 Our mission at Reactime is to maintain and iterate constantly, but never at the expense of future developers.<br />We know how hard it is to quickly get up to speed and onboard in a new codebase.<br />So, here are some helpful pointers to help you hit the ground running. 🏃🏾💨
 
+## Building from source
+
+1. If you have already installed Reactime from the Chrome Web Store, disable or uninstall it.
+2. Run `yarn` to install all dependencies.
+3. Run `yarn dev`. This will start a `webpack` process which watches for file changes and whenever it sees some, automatically rebuilds the webpack bundles used by the extension.
+4. Go to `chrome://extensions`
+5. Ensure Developer mode is enabled
+6. Click `Load unpacked`
+7. Select the `src/extension/build` directory
+
+Now you should be able to change Reactime code and see the changes instantly reflected in your browser!
+
 <b>With release of Node v18.12.1 (LTS) on 11/4/22, the script has been updated to 'npm run dev' | 'npm run build' for backwards compatibility.<br/>
 For version Node v16.16.0, please use script 'npm run devlegacy' | 'npm run buildlegacy'</b>