diff --git a/README.md b/README.md index c0b68f3ec..5c1e56e3a 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,7 @@ This section provides a high-level requirement & quick start guide. **For detail - [Ruby](https://www.ruby-lang.org/en/): we recommend using [rbenv](https://github.com/rbenv/rbenv) to install the Ruby version listed on the badge. - [Yarn](https://yarnpkg.com/): please refer to their [installation guide](https://yarnpkg.com/en/docs/install). - [PostgreSQL](https://www.postgresql.org/) 9.4 or higher. +- [ImageMagick](https://imagemagick.org/): please refer to ImageMagick's [installation instructions](https://imagemagick.org/script/download.php). Alternatively, macOS users can install ImageMagick with `brew install imagemagick`. ### Standard Installation @@ -80,7 +81,7 @@ This section provides a high-level requirement & quick start guide. **For detail 1. Clone your forked repository, ie. `git clone https://github.com//dev.to.git` 1. Set up your environment variables/secrets - - Take a look at `Envfile`. This file lists all the `ENV` variables we use and provides a fake default for any missing keys. You'll need to get your own free [Algolia credentials](https://docs.dev.to/backend/algolia/) to get your development environment running. + - Take a look at `Envfile`. This file lists all the `ENV` variables we use and provides a fake default for any missing keys. You'll need to get your own free [Algolia credentials](https://docs.dev.to/backend/algolia/) to get your development environment running. You can add these to your `config/application.yml` file using the process described below. - This [guide](https://docs.dev.to/backend/) will show you how to get free API keys for additional services that may be required to run certain parts of the app. - For any key that you wish to enter/replace: 1. Create `config/application.yml` by copying from the provided template (ie. with bash: `cp config/sample_application.yml config/application.yml`). This is a personal file that is ignored in git.