Skip to content

Commit d7cfe7f

Browse files
committed
add some additional details to README.rst
1 parent 1df85f0 commit d7cfe7f

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,22 @@ Introduction
22
============
33

44
This library provides best-guess platform detection for a range of single-board
5-
computers and (potentially) other platforms. It's intended for use in
6-
`Adafruit_Blinka <https://github.com/adafruit/Adafruit_Blinka>`_, but may be
5+
computers and (potentially) other platforms. It was written primarily for use
6+
in `Adafruit_Blinka <https://github.com/adafruit/Adafruit_Blinka>`_, but may be
77
useful in other contexts.
88

9+
Platform detection is divided into "chip" and "board" detection, with the latter
10+
generally dependent on the former. Platform info is gathered from:
11+
12+
- Python's `sys.platform`
13+
14+
- The `/proc/cpuinfo` file on Linux systems (for processor info, Raspberry Pi
15+
hardware revisions, etc.)
16+
17+
- Beaglebone EEPROM board IDs
18+
19+
- Distribution-specific files such as `/etc/armbian-release`.
20+
921
The API is currently unstable and may change drastically in future releases.
1022

1123
Installation

0 commit comments

Comments
 (0)