Browse Source

add some additional details to README.rst

Brennen Bearnes 3 months ago
parent
commit
d7cfe7f992
1 changed files with 14 additions and 2 deletions
  1. 14
    2
      README.rst

+ 14
- 2
README.rst View File

@@ -2,10 +2,22 @@ Introduction
2 2
 ============
3 3
 
4 4
 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
7 7
 useful in other contexts.
8 8
 
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
+
9 21
 The API is currently unstable and may change drastically in future releases.
10 22
 
11 23
 Installation

Loading…
Cancel
Save