Skip to content

Commit

Permalink
📝 Add Mac OS specific profiles (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
kammce authored Dec 6, 2024
1 parent 8a089ba commit 3153760
Showing 1 changed file with 69 additions and 17 deletions.
86 changes: 69 additions & 17 deletions mkdocs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,16 @@ What you will need in order to get started with libhal.
sudo apt install Python3.10
```

Install `pipx` which is used to install conan:

```
sudo apt install pipx
```

Installing conan:

```
python3 -m pip install "conan>=2.2.2"
pipx install "conan>=2.10.1"
```

=== "MacOS X"
Expand All @@ -56,12 +62,13 @@ What you will need in order to get started with libhal.
```
brew install python
brew install llvm@17
brew install pipx
```

Install conan:

```
python3 -m pip install "conan>=2.2.2"
pipx install "conan>=2.10.1"
```

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

```powershell
python -m pip install -U "conan>=2.2.2"
python -m pip install -U "conan>=2.10.1"
```

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

=== "M1 Mac"
=== "Intel Windows"

If your Windows machine uses an Intel processor then you'll want to use this
default configuration.

```bash
conan config install -sf profiles/x86_64/windows/ -tf profiles https://github.com/libhal/conan-config.git
```

=== "ARM64 Windows"

If you have a modern surface laptop with ARM64, then this may be the right
choice for you (this profile is untested).

```bash
conan config install -sf profiles/armv8/windows/ -tf profiles https://github.com/libhal/conan-config.git
```

---

For M1 Mac users:

=== "M1 Mac 13 (Ventura)"

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

```bash
conan config install -sf profiles/armv8/mac/ -tf profiles https://github.com/libhal/conan-config.git
conan config install -sf profiles/armv8/mac-13/ -tf profiles https://github.com/libhal/conan-config.git
```

=== "Intel Mac"
=== "M1 Mac 14 (Sonoma)"

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

```bash
conan config install -sf profiles/armv8/mac-14/ -tf profiles https://github.com/libhal/conan-config.git
```

=== "M1 Mac 15 (Sequoia)"

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

```bash
conan config install -sf profiles/armv8/mac-15/ -tf profiles https://github.com/libhal/conan-config.git
```

---

For Intel Mac users:

=== "Intel Mac 13 (Ventura)"

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

```bash
conan config install -sf profiles/x86_64/mac/ -tf profiles https://github.com/libhal/conan-config.git
conan config install -sf profiles/x86_64/mac-13/ -tf profiles https://github.com/libhal/conan-config.git
```

=== "Intel Windows"
=== "Intel Mac 14 (Sonoma)"

If your Windows machine uses an Intel processor then you'll want to use this
default configuration.
If your Mac Book uses an Intel processor then you'll want to use this default
configuration.

```bash
conan config install -sf profiles/x86_64/windows/ -tf profiles https://github.com/libhal/conan-config.git
conan config install -sf profiles/x86_64/mac-14/ -tf profiles https://github.com/libhal/conan-config.git
```

=== "ARM64 Windows"
=== "Intel Mac 15 (Sequoia)"

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

```bash
conan config install -sf profiles/armv8/windows/ -tf profiles https://github.com/libhal/conan-config.git
conan config install -sf profiles/x86_64/mac-15/ -tf profiles https://github.com/libhal/conan-config.git
```

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

On other systems you may have to just use `python` as the command.

```bash
nxpprog --control --binary demos/build/lpc4078/MinSizeRel/uart.elf.bin --device /dev/tty.usbserial-140
```
Expand Down Expand Up @@ -389,13 +442,12 @@ In order to complete this tutorial you'll one of these devices:

### On Linux

Add yourself to the dialout user group to give yourself the permission.
Add yourself to the dialout user group to give yourself the permission.
This group has the permission to talk to serial ports.

```
$ usermod -a -G dialout $USER
```


## ⚡️ Changing Built Type

Expand Down

0 comments on commit 3153760

Please sign in to comment.