You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-9Lines changed: 39 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -117,7 +117,11 @@ To get started with OpenAstroFirmware development or to build and deploy the fir
117
117
- GPIO-based stepper motor drivers
118
118
- Testing/simulation drivers for development
119
119
120
-
### Prerequisites
120
+
### Development Environment Setup
121
+
122
+
Before getting started, make sure you have a proper Zephyr development environment. Follow the official [Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/getting_started/index.html).
123
+
124
+
#### Prerequisites
121
125
122
126
-**Zephyr SDK** - Required for cross-compilation and board support
123
127
-**West** - Zephyr's meta-tool for project management and building
@@ -128,14 +132,40 @@ To get started with OpenAstroFirmware development or to build and deploy the fir
128
132
129
133
#### Installation
130
134
131
-
1. Install the Zephyr SDK following the [official Zephyr getting started guide](https://docs.zephyrproject.org/latest/getting_started/index.html)
132
-
2. Set up the Python virtual environment and install West:
135
+
1.**Install the Zephyr SDK**: Follow the [official Zephyr getting started guide](https://docs.zephyrproject.org/latest/getting_started/index.html) for your operating system.
136
+
137
+
2.**Set up Python virtual environment and install West**:
133
138
```bash
134
139
python3 -m venv ~/.venv
135
140
source~/.venv/bin/activate
136
141
pip install west
137
142
```
138
143
144
+
#### Workspace Initialization
145
+
146
+
The first step is to initialize the workspace folder where the `OpenAstroFirmware` and all Zephyr modules will be cloned. Run the following command:
147
+
148
+
```bash
149
+
# Initialize workspace for OpenAstroFirmware
150
+
west init -m https://github.com/OpenAstroTech/OpenAstroFirmware --mr main OpenAstroTech-workspace
151
+
# Update Zephyr modules
152
+
cd OpenAstroTech-workspace
153
+
west update
154
+
```
155
+
156
+
After initialization, your workspace structure will look like:
0 commit comments