diff --git a/README.md b/README.md index a06f47a43..ba87c0e9b 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,7 @@ Cortex follows a decentralized, API-only architecture - it is *not* built like W - [Webpages and Snippets](#webpages-and-snippets) - [Exceptions](#exceptions) - [Applications Using Cortex](#applications-using-cortex) +- [Troubleshooting](#troubleshooting) - [Contributing](#contributing) - [License](#license) - [Copyright](#copyright) @@ -55,7 +56,7 @@ Copy and rename the example `.env.example` file as `.env` and modify it to match For a rudimentary setup, these variables should be configured: -* Use `$ rake secret` to generate `APP_SECRET` and `DEVISE_SECRET` +* Execute `$ bundle exec rails secret` twice to generate both an `APP_SECRET` and `DEVISE_SECRET` * If the superuser isn't used for the app databases, the `DATABASE_USERNAME` and `DATABASE_PASSWORD` should be set accordingly. * Set `HOST` to the local Web server's root URL to properly configure Fog (local asset storage) @@ -312,6 +313,9 @@ If a consuming or companion application would like to produce Cortex-equivalent * [CB1 Lander Shell](https://github.com/cbdr/cb1-lander-shell) - Platform for hosting lander pages and experiments, utilizing Cortex Posts and Sinatra. [Live Site](http://corporate.careerbuilder.com/) * [CareerBuilder.com](https://github.com/cbdr/consumer-main) - The main Consumer Web site for CB.com uses Cortex Posts for the [Privacy](http://www.careerbuilder.com/privacy) and [Terms of Service](http://www.careerbuilder.com/terms) pages. +## Troubleshooting +* For OS X / homebrew users: Run `which node` to ensure node is properly linked. The path shown should match homebrew's default installation path (run `which brew` to reveal this). If its not, then run `brew link node` and follow the instructions. + ## Contributing Anyone and everyone is encouraged to fork Cortex and submit pull requests, propose new features and create issues.