From 081e20b702e6419195655b957981451547f3a567 Mon Sep 17 00:00:00 2001
From: Samuel Dionne-Riel <samuel@dionne-riel.com>
Date: Tue, 7 Jan 2020 15:20:13 -0500
Subject: [PATCH] Adds notes

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 40 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 4a340aa..06d3747 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,36 @@
 WIP stuff to get started on the pinebook pro.
 
-## `u-boot`
+## Using in your configuration
 
-Assuming `/dev/mmcblk0` is an SD card.
+Clone this repository somwhere, and in your configuration.nix
 
 ```
-$ nix-build -A pkgs.uBootPinebookPro
-$ lsblk /dev/mmcblk0 && sudo dd if=result/idbloader.img of=/dev/mmcblk0 bs=512 seek=64 oflag=direct,sync && sudo dd if=result/u-boot.itb of=/dev/mmcblk0 bs=512 seek=16384 oflag=direct,sync
+{
+  imports = [
+    .../pinebook-pro/pinebook_pro.nix
+  ];
+}
 ```
 
-The eMMC has to be zeroed (in the relevant sectors) or else the RK3399 will use
-the eMMC as a boot device first.
+That entry point will try to stay unopinionated, while maximizing the hardware
+compatibility.
 
-Alternatively, this u-boot can be installed to the eMMC.
+## Compatibility
 
-Installing to SPI has yet to be investigated.
+### Tested
+
+ * X11 with modesetting
+ * Wi-Fi
+ * Brightness controls
+
+### Untested
+
+ * Bluetooth
+
+### Known issues
+
+ * Suspend (or resume) fails.
+ * Rebooting fails somewhere early in the u-boot SPL.
 
 ## Image build
 
@@ -43,3 +59,19 @@ This will automatically detect the need for cross-compiling or not.
 When cross-compiled, all caveats apply. Here this mainly means that the kernel
 will need to be re-compiled on the device on the first nixos-rebuild switch,
 while most other packages can be fetched from the cache.
+
+## `u-boot`
+
+Assuming `/dev/mmcblk0` is an SD card.
+
+```
+$ nix-build -A pkgs.uBootPinebookPro
+$ lsblk /dev/mmcblk0 && sudo dd if=result/idbloader.img of=/dev/mmcblk0 bs=512 seek=64 oflag=direct,sync && sudo dd if=result/u-boot.itb of=/dev/mmcblk0 bs=512 seek=16384 oflag=direct,sync
+```
+
+The eMMC has to be zeroed (in the relevant sectors) or else the RK3399 will use
+the eMMC as a boot device first.
+
+Alternatively, this u-boot can be installed to the eMMC.
+
+Installing to SPI has yet to be investigated.