aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2019-01-08 16:22:02 +0100
committerHarald Welte <laforge@gnumonks.org>2019-01-08 16:22:02 +0100
commite9be974c5cd6a61117f1bf7ace06ab4f9ce5a3ca (patch)
treed89f7d179d6c5c773f1a715fc8f1983e9d5354ea
parentb57baadfd42f184ef9ba52baf92cff11f4342498 (diff)
Add README.md file
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89abd09
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+titan.TestPorts.USB
+===================
+
+This implements a TTCN-3 USB test port for Eclipse TITAN. Running on a (Linux) USB host computer,
+it allows you to write TTCN-3 tests for USB device. This means that the USB host (including
+the Linux kernel USB stack, libusb-1.0 and titan.TestPorts.USB form the tester, and the
+USB device with its built-in firmware forms the IUT(Implementation under Test).
+
+The idea of this module is to be able to write abstract test suites in TTCN-3 which verify
+the functionality, and or interoperability of the interface/protocol they expose. The first
+such implementation for which this TestPort is going to be used is the osmo-ccid program,
+a USB device side implementation of the USB CCID (Chipcard Interface Device) class.
+
+
+GIT repository
+--------------
+
+You can clone from the official titan.TestPorts.USB repository using
+
+ git clone https://git.osmocom.org/titan.TestPorts.USB
+
+There's a cgit interface at <https://cgit.osmocom.org/titan.TestPorts.USB/>
+
+Documentation
+-------------
+
+This is still very much a Work-In-Progress, and hence there's no documentation yet, sorry.