From 42c6368927656703799cc60bb733de91e9b74068 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Sun, 21 Dec 2014 18:36:45 +0100
Subject: update README, deprecate main.c

---
 README.md | 34 +++++++++++++++++++++++-----------
 main.c    | 10 ++++++++++
 2 files changed, 33 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 2ca7530..b1bafba 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,39 @@
 # owi-slave
 
 Implementation of an One Wire Interface slave device on an ATTiny 2313A without
-external clock. Work-in-progress.
+external clock.
 
 Though the schematic suggests bus-powered operation, the AVR's power
-consumption may be too high for this to work. If connecting the AVR causes the
-bus voltage to drop below 3V, consider replacing the capacitors with a ~4.5V
-battery. Do not use a mains power supply -- it may not have the same GND as
-the 1-Wire bus.
+consumption is probably too high for this to work. If connecting the AVR causes
+the bus voltage to drop below 3V, consider replacing the capacitors with a
+~4.5V battery. Do not use a mains power supply -- it may not have the same
+ground level as the 1-Wire bus.
 
 # Building
 
+set the desired onewire address in main.S. then run
+
     make && sudo make flash
 
 ## supported features
 
-Successfully tested on a DS2482-100 Single Channel 1-Wire Master.
-Tests with a commercially available iButton reader will follow soon.
+### READ ROM (0x33)
+
+Works fine. Successfully tested on:
+
+* DS2482-100 Single Channel 1-Wire Master
+* IBL USB iButton reader
+
+### SEARCH ROM (0xf0)
+
+the code in main.c works on one-device buses, the code in main.S was not tested
+yet. SEARCH ROM on a multi-device bus does not work.
+
+Successfully tested on:
 
-* Read ROM (0x33) with 64bit identifier
-* Search ROM (0xf0) with 64bit identifier -- does not yet check the master
-  direction indicator, though, so only useful on a one-device bu
+* DS2482-100 Single Channel 1-Wire Master
 
 ## TODO
 
-* Overdrive Read ROM / Search ROM
+* test SEARCH ROM
+* implement readout of master direction bit in SEARCH ROM
diff --git a/main.c b/main.c
index 612fc66..91993d7 100644
--- a/main.c
+++ b/main.c
@@ -10,6 +10,16 @@
  */
 
 
+/*
+ * +----- NOTE ------ NOTE ------ NOTE ------ NOTE ------ NOTE -----+
+ * |                                                                |
+ * |     This code is deprecated and no longer maintained.          |
+ * |     It is only kept as a reference for main.S                  |
+ * |     Please refer to main.S for the up-to-date implementation   |
+ * |                                                                |
+ * +----- NOTE ------ NOTE ------ NOTE ------ NOTE ------ NOTE -----+
+ */
+
 
 /*
  * Set the 64bit ID (including 8bit CRC) here, in the order in which they are
-- 
cgit v1.2.3