Skip to content

Commit f2e48d1

Browse files
committed
docs: update docs after cli init command was added
1 parent 8a15cf8 commit f2e48d1

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

docs/changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3434
- CLI command `corsair check` to validate input files
3535
- CLI command `corsair schema` to generate JSON-schemas of input files for IDE hints, autocompletion and validation
3636
- CLI command `corsair build` to render outputs
37+
- CLI command `corsair init` to initialize a new project
3738
- `BuildSpecification` data model to store build targets and configuration
3839
- Register map data models (`Map`, `Register`, `Field`, `Enum`, `EnumMember`) for internal CSR representation
3940
- `SetializedParser` to parse register map from JSON/YAML/HJSON files

docs/first-steps.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,26 @@ icon: octicons/mortar-board-16
44

55
# First Steps
66

7-
TODO
7+
After completing the installation as described in the [Installation guide](./installation.md), you can create a new project and build it.
8+
9+
You can quickly create a new project using the [`corsair init`](./cli.md#corsair-init) command:
10+
11+
```bash
12+
corsair init
13+
```
14+
15+
This command will create two files in the current directory: `csrmap.yaml` and `csrbuild.yaml`.
16+
17+
The first file, `csrmap.yaml`, describes the source CSR map. It contains the definitions of your registers and their fields. The second file, `csrbuild.yaml`, is the build file. It specifies how to process the `csrmap.yaml` and what output files (like RTL code, software headers, or documentation) should be generated.
18+
19+
Once you have your register map defined and the build file configured, you can generate the output files using the [`corsair build`](./cli.md#corsair-build) command:
20+
21+
```bash
22+
corsair build
23+
```
24+
25+
This command will process your input files according to the `csrbuild.yaml` specification and place all generated artifacts into the `corsair-build` directory by default.
26+
27+
To learn more about the underlying principles of Corsair, refer to the [Workflow](./concepts/workflow.md) section in our concepts guide.
28+
29+
For detailed information on the formats of the input files, please see the [Build File](./build-file/index.md) and [Register File](./register-file/index.md) documentation.

0 commit comments

Comments
 (0)