Add some actual NEC IR protocol dumps.

[sigrok-dumps.git] / README

diff --git a/README b/README
index 19cceb9ac2929dfa0d5e74b8060c110cdaa7d384..cc6a1259f15de7f8c87959a1bdda6d880e3ff4f3 100644 (file)
--- a/README
+++ b/README
@@ -2,19 +2,50 @@
 README
 -------------------------------------------------------------------------------
 
 README
 -------------------------------------------------------------------------------
 

-This is a collection of logic analyzer example data, covering various
-protocols (e.g. I2C, SPI, USART, etc).
+The sigrok project aims at creating a portable, cross-platform,
+Free/Libre/Open-Source signal analysis software suite that supports various
+device types (such as logic analyzers, oscilloscopes, multimeters, and more).

 
 

+sigrok-dumps is a collection of logic analyzer example data, covering various
+protocols (e.g. I2C, SPI, UART, etc).

 
 

-License
--------
+
+Status
+------
+
+sigrok-dumps is in a usable state and has had official tarball releases.
+
+
+Contributing dumps
+------------------
+
+See http://sigrok.org/wiki/Example_dumps for details.
+
+
+Copyright and license
+---------------------

 
 Unless noted otherwise, all dump files are hereby released into the
 public domain by their authors.
 
 
 
 Unless noted otherwise, all dump files are hereby released into the
 public domain by their authors.
 
 

-Further information
--------------------
+Mailing lists
+-------------
+
+There are two mailing lists for sigrok/sigrok-dumps:
+
+ https://lists.sourceforge.net/lists/listinfo/sigrok-devel
+ https://lists.sourceforge.net/lists/listinfo/sigrok-commits
+
+
+IRC
+---
+
+You can find the sigrok developers in the #sigrok IRC channel on Freenode.
+
+
+Website
+-------

 
 

-http://sigrok.org
+ http://sigrok.org/wiki/Example_dumps