Skip to content

Commit 0f67526

Browse files
justin808claude
andcommitted
Add installation instructions and improve note placement
Following review feedback, this commit: - Adds installation instructions for both overmind and foreman - Moves the note before the command block so developers see prerequisites first - Confirms file ends with newline as required by CLAUDE.md Installation instructions include: - overmind: brew install for macOS with link to full installation guide - foreman: gem install with important note about global installation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 3f8ce8c commit 0f67526

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/getting-started.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ cd PROJECT_NAME
6666
bundle exec rails generate react_on_rails:install
6767
```
6868

69+
> **Note:** Ensure that you have `overmind` or `foreman` installed to run `bin/dev`.
70+
>
71+
> - **overmind**: `brew install overmind` (macOS) or see [installation guide](https://github.com/DarthSim/overmind#installation)
72+
> - **foreman**: `gem install foreman` (install globally, not in your project bundle - [details](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman))
73+
6974
Start the app:
7075

7176
```bash
@@ -74,8 +79,6 @@ bin/dev # start with hmr
7479
bin/dev static # start with statically created bundles (no HMR)
7580
```
7681

77-
> **Note:** Ensure that you have `overmind` or `foreman` installed to run `bin/dev`.
78-
7982
## Basic Usage
8083

8184
### Configuration

0 commit comments

Comments
 (0)