Skip to content

Commit 6950774

Browse files
committed
fix(docs): clarify Igniter quick start instructions (#72)
Lead with `mix igniter.new` for starting from scratch and document the `igniter_new` archive prerequisite. Keep `mix igniter.install bb` as a secondary option for existing projects. Closes #72
1 parent 1a9bd52 commit 6950774

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

documentation/tutorials/01-first-robot.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,25 @@ This tutorial guides you through defining your first robot with Beam Bots. By th
1515

1616
### Quick Start with Igniter
1717

18-
The fastest way to get started is with [Igniter](https://hex.pm/packages/igniter):
18+
The fastest way to get started is with [Igniter](https://hex.pm/packages/igniter). First, install the `igniter_new` archive if you haven't already:
1919

2020
```bash
21-
mix igniter.install bb
21+
mix archive.install hex igniter_new
22+
```
23+
24+
Then create a new project with BB installed:
25+
26+
```bash
27+
mix igniter.new my_robot --install bb
2228
```
2329

24-
This creates a `{YourApp}.Robot` module with arm/disarm commands and a base link, adds it to your supervision tree, and configures the formatter. You can skip to [Step 2](#step-2-add-a-joint-and-child-link) and modify the generated module.
30+
This creates a new Elixir project with a `MyRobot.Robot` module containing arm/disarm commands and a base link, adds it to your supervision tree, and configures the formatter. You can skip to [Step 2](#step-2-add-a-joint-and-child-link) and modify the generated module.
31+
32+
If you already have an existing Elixir project, you can add BB to it instead:
33+
34+
```bash
35+
mix igniter.install bb
36+
```
2537

2638
### Manual Installation
2739

0 commit comments

Comments
 (0)