Add README

1 files changed, 15 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..0cca129
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+Classes present in this repository are dummies, and should fully implement
+the expected API that'll be used in Settings. 
+
+Each device should implement its own classes for supported hardware 
+tunables, and signal their existence by adding a BOARD_HARDWARE_CLASS 
+variable to its BoardConfig, pointing to the path where said classes
+can be found. The Nexus4, for instance, has
+
+BOARD_HARDWARE_CLASS := device/lge/mako/cmhw/
+
+Every class present in this framework addresses a hardware tunable;
+Devices don't need to implement all the classes, but for every one
+that _is_ implemented, all methods existing in this dummy implementation
+must be present.
+