Skip to content

Commit 8a5791c

Browse files
committed
updated readme
1 parent 66088c5 commit 8a5791c

3 files changed

Lines changed: 20 additions & 23 deletions

File tree

build/readme.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,3 @@ Eexcept the `pack_*` scripts don't.
6161
```
6262
$ ./build.sh [cleanAll] cmake make
6363
```
64-
65-
66-
67-
---
68-
69-
### files to edit on version update
70-
71-
- `build/dep_vstr.txt`
72-
- `include/rpihal/defs.h`

dev-info.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1-
#### just some links
1+
# rpihal developper info - cheat-sheet - link collection
2+
3+
## TODO
4+
- add more `RPIHAL_ui128_..` functions
5+
- add to unit test
6+
- `RPIHAL_GPIO_bittopin`
7+
- `RPIHAL_GPIO_pintobit`
8+
- `RPIHAL_ui128_..`
9+
10+
## files to edit on version update
11+
- `build/dep_vstr.txt`
12+
- `include/rpihal/defs.h`
13+
14+
15+
16+
## just some links
217
- https://elinux.org/RPi_GPIO_Code_Samples
318
- https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#general-purpose-io-gpio
419
- https://www.raspberrypi.org/app/uploads/2012/02/BCM2835-ARM-Peripherals.pdf + https://elinux.org/BCM2835_datasheet_errata
@@ -14,7 +29,7 @@
1429
- https://github.com/raspberrypi/documentation/blob/develop/documentation/asciidoc/computers/raspberry-pi/revision-codes.adoc
1530

1631

17-
## 32bit vs 64bit
32+
### 32bit vs 64bit
1833
- https://raspberrypi.stackexchange.com/a/143293
1934
#### 32bit (2024-03-15-raspios-bookworm-armhf)
2035
```

readme.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The library automatically detects the Raspberry Pi Model.
1111
> __CAUTION!__ Unexpected behaviour may be observed on alternate functions (see [ANOM1](anomalies.md#anom1---gpio-alternate-function-registers)).
1212
1313
### Supported Models
14-
`2B` and newer, except `5` and it's derivates. Zeros, Compute Modules and the `400` could not yet be tested.
14+
`2B` and newer, except `5` and it's derivates. Compute Modules could not yet be tested.
1515

1616
> Search for _ADDHW_ comments in code to find sections which are crucial for implementation of more hardware support.
1717
@@ -46,6 +46,8 @@ See [build/readme.md](./build/readme.md) for the different build methods.
4646

4747
## Emulator
4848

49+
> I2C, SPI and UART are not yet supported in the emulator.
50+
4951
### Build
5052
> Yet only GPIOs are implemented in the emulator.
5153
The emulator can be used to run your project on your working machine. To build the emulator project
@@ -62,14 +64,3 @@ The left and right mouse button can be used to click (push a button) or toggle a
6264

6365
### Credits
6466
The emulator uses the OneLoneCoder [Pixel Game Engine](https://github.com/OneLoneCoder/olcPixelGameEngine) for the graphics.
65-
66-
67-
68-
---
69-
70-
## TODO
71-
- add more `RPIHAL_ui128_..` functions
72-
- add to unit test
73-
- `RPIHAL_GPIO_bittopin`
74-
- `RPIHAL_GPIO_pintobit`
75-
- `RPIHAL_ui128_..`

0 commit comments

Comments
 (0)