Skip to content

Commit 775e9a5

Browse files
committed
Update README
1 parent 65f2ec5 commit 775e9a5

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ As well as a higher-level abstracted interface for easy access to some of the mo
88

99
## Installation
1010

11-
### Linux
11+
### Linux & FreeBSD
1212

1313
> [!NOTE]
1414
> Don't forget to read the [permissions](#permissions) section below.
@@ -19,13 +19,13 @@ For a basic installation with full Linux Device support, run:
1919
pip install cros-ec-python
2020
```
2121

22-
Some interfaces require additional dependencies, for example the LPC interface performs best with the `portio` package:
22+
Some interfaces require additional dependencies, for example the LPC & MEC interface performs best with the `portio` package:
2323

2424
```bash
2525
pip install cros-ec-python[lpc]
2626
```
2727

28-
#### Permissions
28+
#### Linux Permissions
2929

3030
Since we're playing around with actual hardware, we're going to need some pretty high permissions.
3131

@@ -56,7 +56,7 @@ It's easiest just to run your script as root.
5656
> [!NOTE]
5757
> Loading a driver will likely require administrator permissions, so you may need to run your script as an administrator.
5858
59-
The Windows version supports 3 different drivers to access the EC:
59+
The Windows version supports 3 different drivers to access the EC (only one is required):
6060

6161
- The Framework EC driver which is provided in the driver bundles and requires a supported BIOS version. This driver does not require administrator and is the recommended way of using CrOS_EC_Python on supported devices.
6262
- `PawnIO` which is a fairly new scriptable kernel driver, the official signed version can be downloaded [here](https://pawnio.eu/).
@@ -76,7 +76,7 @@ pip install cros-ec-python
7676
[PawnIO](https://pawnio.eu/) can be installed using the installer from the website.
7777
PawnIO is signed and does not require disabling driver signature enforcement.
7878

79-
You will also need to download the [`LpcCrOSEC`](https://github.com/namazso/PawnIO.Modules/pull/3) module, and copy it to your working directory.
79+
You will also need to download the [latest release](https://github.com/namazso/PawnIO.Modules/releases/) of the PawnIO modules and copy `LpcCrOSEC.bin` to your working directory.
8080

8181
#### WinRing0
8282

@@ -125,7 +125,7 @@ pdoc cros_ec_python
125125

126126
- [x] Linux Device (Requires the `cros_ec_dev` kernel module)
127127
- [x] Windows Framework EC Driver
128-
- [x] Windows [PawnIO](https://pawnio.eu/) using [LpcCrOSEC](https://github.com/namazso/PawnIO.Modules/pull/3)
128+
- [x] Windows [PawnIO](https://pawnio.eu/) using [LpcCrOSEC](https://github.com/namazso/PawnIO.Modules/releases/)
129129
- [x] LPC Bus Interface (Soft-requires the [`portio` package](https://pypi.org/project/portio/))
130130
- [x] MEC LPC Interface (Soft-requires the [`portio` package](https://pypi.org/project/portio/))
131131
- [ ] I2C Interface

0 commit comments

Comments
 (0)