Skip to content

Commit 3153760

Browse files
authored
📝 Add Mac OS specific profiles (#67)
1 parent 8a089ba commit 3153760

1 file changed

Lines changed: 69 additions & 17 deletions

File tree

mkdocs/getting_started.md

Lines changed: 69 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,16 @@ What you will need in order to get started with libhal.
3737
sudo apt install Python3.10
3838
```
3939

40+
Install `pipx` which is used to install conan:
41+
42+
```
43+
sudo apt install pipx
44+
```
45+
4046
Installing conan:
4147

4248
```
43-
python3 -m pip install "conan>=2.2.2"
49+
pipx install "conan>=2.10.1"
4450
```
4551

4652
=== "MacOS X"
@@ -56,12 +62,13 @@ What you will need in order to get started with libhal.
5662
```
5763
brew install python
5864
brew install llvm@17
65+
brew install pipx
5966
```
6067

6168
Install conan:
6269

6370
```
64-
python3 -m pip install "conan>=2.2.2"
71+
pipx install "conan>=2.10.1"
6572
```
6673

6774
Make `clang-tidy` available on the command line:
@@ -124,7 +131,7 @@ What you will need in order to get started with libhal.
124131
Install conan (must be in admin powershell):
125132

126133
```powershell
127-
python -m pip install -U "conan>=2.2.2"
134+
python -m pip install -U "conan>=2.10.1"
128135
```
129136

130137
There is no more installation required at this point.
@@ -182,40 +189,84 @@ Now install the profile for your particular OS and CPU architecture.
182189
conan config install -sf profiles/armv8/linux/ -tf profiles https://github.com/libhal/conan-config.git
183190
```
184191

185-
=== "M1 Mac"
192+
=== "Intel Windows"
193+
194+
If your Windows machine uses an Intel processor then you'll want to use this
195+
default configuration.
196+
197+
```bash
198+
conan config install -sf profiles/x86_64/windows/ -tf profiles https://github.com/libhal/conan-config.git
199+
```
200+
201+
=== "ARM64 Windows"
202+
203+
If you have a modern surface laptop with ARM64, then this may be the right
204+
choice for you (this profile is untested).
205+
206+
```bash
207+
conan config install -sf profiles/armv8/windows/ -tf profiles https://github.com/libhal/conan-config.git
208+
```
209+
210+
---
211+
212+
For M1 Mac users:
213+
214+
=== "M1 Mac 13 (Ventura)"
186215

187216
If your Mac Book uses an M1 processor then you'll want to use this default
188217
configuration.
189218

190219
```bash
191-
conan config install -sf profiles/armv8/mac/ -tf profiles https://github.com/libhal/conan-config.git
220+
conan config install -sf profiles/armv8/mac-13/ -tf profiles https://github.com/libhal/conan-config.git
192221
```
193222

194-
=== "Intel Mac"
223+
=== "M1 Mac 14 (Sonoma)"
224+
225+
If your Mac Book uses an M1 processor then you'll want to use this default
226+
configuration.
227+
228+
```bash
229+
conan config install -sf profiles/armv8/mac-14/ -tf profiles https://github.com/libhal/conan-config.git
230+
```
231+
232+
=== "M1 Mac 15 (Sequoia)"
233+
234+
If your Mac Book uses an M1 processor then you'll want to use this default
235+
configuration.
236+
237+
```bash
238+
conan config install -sf profiles/armv8/mac-15/ -tf profiles https://github.com/libhal/conan-config.git
239+
```
240+
241+
---
242+
243+
For Intel Mac users:
244+
245+
=== "Intel Mac 13 (Ventura)"
195246

196247
If your Mac Book uses an Intel processor then you'll want to use this default
197248
configuration.
198249

199250
```bash
200-
conan config install -sf profiles/x86_64/mac/ -tf profiles https://github.com/libhal/conan-config.git
251+
conan config install -sf profiles/x86_64/mac-13/ -tf profiles https://github.com/libhal/conan-config.git
201252
```
202253

203-
=== "Intel Windows"
254+
=== "Intel Mac 14 (Sonoma)"
204255

205-
If your Windows machine uses an Intel processor then you'll want to use this
206-
default configuration.
256+
If your Mac Book uses an Intel processor then you'll want to use this default
257+
configuration.
207258

208259
```bash
209-
conan config install -sf profiles/x86_64/windows/ -tf profiles https://github.com/libhal/conan-config.git
260+
conan config install -sf profiles/x86_64/mac-14/ -tf profiles https://github.com/libhal/conan-config.git
210261
```
211262

212-
=== "ARM64 Windows"
263+
=== "Intel Mac 15 (Sequoia)"
213264

214-
If you have a modern surface laptop with ARM64, then this may be the right
215-
choice for you (this profile is untested).
265+
If your Mac Book uses an Intel processor then you'll want to use this default
266+
configuration.
216267

217268
```bash
218-
conan config install -sf profiles/armv8/windows/ -tf profiles https://github.com/libhal/conan-config.git
269+
conan config install -sf profiles/x86_64/mac-15/ -tf profiles https://github.com/libhal/conan-config.git
219270
```
220271

221272
---
@@ -308,6 +359,8 @@ In order to complete this tutorial you'll one of these devices:
308359
python3.10 -m pip install nxpprog
309360
```
310361

362+
On other systems you may have to just use `python` as the command.
363+
311364
```bash
312365
nxpprog --control --binary demos/build/lpc4078/MinSizeRel/uart.elf.bin --device /dev/tty.usbserial-140
313366
```
@@ -389,13 +442,12 @@ In order to complete this tutorial you'll one of these devices:
389442

390443
### On Linux
391444

392-
Add yourself to the dialout user group to give yourself the permission.
445+
Add yourself to the dialout user group to give yourself the permission.
393446
This group has the permission to talk to serial ports.
394447

395448
```
396449
$ usermod -a -G dialout $USER
397450
```
398-
399451

400452
## ⚡️ Changing Built Type
401453

0 commit comments

Comments
 (0)