diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index db5ed0a65b..f244d9ca45 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -6,12 +6,13 @@ This is a general guide to setting up an Open Food Network **development environ The fastest way to make it work locally is to use Docker, you only need to setup git, see the [Docker setup guide](docker/README.md). Otherwise, for a local setup you will need: -* Ruby 2.3.7 and bundler +* Ruby 2.4.4 and bundler (check current Ruby version in [.ruby-version](https://github.com/openfoodfoundation/openfoodnetwork/blob/master/.ruby-version) file) * PostgreSQL database * Chrome (for testing) The following guides will provide OS-specific step-by-step instructions to get these requirements installed: - [Ubuntu Setup Guide][ubuntu] +- [Debian Setup Guide][debian] - [OSX Setup Guide][osx] If you are likely to need to manage multiple version of ruby on your local machine, we recommend version managers such as [rbenv](https://github.com/rbenv/rbenv) or [RVM](https://rvm.io/). @@ -20,7 +21,7 @@ For those new to Rails, the following tutorial will help get you up to speed wit ### Get it -If you're planning on contributing code to the project (which we [LOVE](CONTRIBUTING.md)), it is a good idea to begin by forking this repo using the `Fork` button in the top-right corner of this screen. You should then be able to use `git clone` to copy your fork onto your local machine. +So you have set up your local environment according to the requirements listed above. If you're planning on contributing code to the project (which we [LOVE](CONTRIBUTING.md)), it is a good idea to begin by forking this repo using the `Fork` button in the top-right corner of this screen. You should then be able to use `git clone` to copy your fork onto your local machine: git clone https://github.com/YOUR_GITHUB_USERNAME_HERE/openfoodnetwork @@ -116,6 +117,7 @@ If these commands succeed, you should be able to [continue the setup process](#g [developer-wiki]: https://github.com/openfoodfoundation/openfoodnetwork/wiki [osx]: https://github.com/openfoodfoundation/openfoodnetwork/wiki/Development-Environment-Setup:-OS-X [ubuntu]: https://github.com/openfoodfoundation/openfoodnetwork/wiki/Development-Environment-Setup:-Ubuntu +[debian]: https://github.com/openfoodfoundation/openfoodnetwork/wiki/Development-Environment-Setup:-Debian [wiki]: https://github.com/openfoodfoundation/openfoodnetwork/wiki [zeus]: https://github.com/burke/zeus [rubocop]: https://rubocop.readthedocs.io/en/latest/