blob: b2571895866036304761c7774f67e0a11861ef6b [file] [log] [blame] [view]
avm99963ea37fdf2021-02-03 01:27:13 +01001# Set up the development environment
2Before starting to develop, you must set up your device. This is what you must
3do:
4
51. [Install Go](https://golang.org/doc/install). On Mac, you can install it
6with [Homebrew](https://brew.sh/) by running `brew install go`.
7 - This is because the build script uses a Go program to generate the
8 manifest.
avm99963efce2102021-03-23 23:23:26 +010091. Install the genmanifest Go program. In order to do this, run
10`go install gomodules.avm99963.com/webext/genmanifest@latest`.
Adrià Vilanova Martínez3465e772021-07-11 19:18:41 +0200111. [Install NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/).
Adrià Vilanova Martínez8aad84f2021-08-20 15:11:38 +0200121. Now, you must clone the git repository to your device to retrieve the
13extension source code. To do that,
14[go here](https://gerrit.avm99963.com/admin/repos/infinitegforums) and execute
15the "clone with commit-msg hook" command listed there (if you sign in you'll see
16several options: cloning via anonymous HTTP, HTTP, or SSH).
Adrià Vilanova Martínez3465e772021-07-11 19:18:41 +0200171. That's it! If you're using a Mac, you're out of luck, because you must
avm99963ea37fdf2021-02-03 01:27:13 +010018perform some more steps.
19
20## Mac-specific configuration
21On a Mac, you must also follow these steps:
22
Adrià Vilanova Martínez13997d82022-01-30 13:35:26 +0100231. [Install Brew](https://brew.sh/) if not installed already.
241. Use Brew to install the following packages: `bash`, `gnu-getopt`, and
25`gnu-sed`. Basically we want to get an updated bash version, an updated version
26of the `getopt` command, and the GNU version of `sed`.
271. Set Brew's bash as the default shell (or just make sure to use Brew's bash
28when compiling the extension).
291. Include the directories where `getopt` and `gnu-sed` were installed to
30`$PATH`.