diff --git a/README.md b/README.md index 34710c62653..0a10da16b40 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Atom will automatically update when a new release is available. * [Linux](docs/build-instructions/linux.md) * [OS X](docs/build-instructions/os-x.md) +* [FreeBSD](docs/build-instructions/freebsd.md) * [Windows](docs/build-instructions/windows.md) ## Developing diff --git a/docs/build-instructions/freebsd.md b/docs/build-instructions/freebsd.md new file mode 100644 index 00000000000..2299d9cab8d --- /dev/null +++ b/docs/build-instructions/freebsd.md @@ -0,0 +1,22 @@ +# FreeBSD + +FreeBSD -RELEASE 64-bit is the recommended platform. + +## Requirements + + * FreeBSD + * `pkg install node` + * `pkg install npm` + * `pkg install libgnome-keyring` + * `npm config set python /usr/local/bin/python2 -g` to ensure that gyp uses Python 2 + +## Instructions + + ```sh + git clone https://github.com/atom/atom + cd atom + script/build # Creates application at /tmp/atom-build/Atom + sudo script/grunt install # Installs command to /usr/local/bin/atom + ``` + +## Troubleshooting diff --git a/docs/build-instructions/linux.md b/docs/build-instructions/linux.md index 9a34f21c52c..0a18ce9f7ab 100644 --- a/docs/build-instructions/linux.md +++ b/docs/build-instructions/linux.md @@ -7,7 +7,7 @@ Ubuntu LTS 12.04 64-bit is the recommended platform. * OS with 64-bit architecture * [node.js](http://nodejs.org/download/) v0.10.x * [npm](http://www.npmjs.org/) v1.4.x - * libgnome-keyring-dev `sudo apt-get install libgnome-keyring-dev` + * libgnome-keyring-dev `sudo apt-get install libgnome-keyring-dev` (refer to your distribution's manual on how to install packages if you are not on Debian or Ubuntu-based systems) * `npm config set python /usr/bin/python2 -g` to ensure that gyp uses Python 2 ## Instructions