From 06ca0ab8991fe36731ae715a072fb12cc22abcca Mon Sep 17 00:00:00 2001 From: Jan Breuer <jan.breuer@jaybee.cz> Date: 周一, 24 6月 2013 22:19:34 +0800 Subject: [PATCH] Update documentation --- README.md | 31 ++++++++++++++++++++++++------- 1 files changed, 24 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 14d65b1..d284238 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,30 @@ SCPI parser library =========== +[SCPI](http://en.wikipedia.org/wiki/Standard_Commands_for_Programmable_Instruments) Parser library aims to provide parsing ability of SCPI commands on instrument side. All commands are defined by its patterns eg: "STATus:QUEStionable:EVENt?". + +Source codes are published with open source Simplified BSD license. + + +Usage +--------------- +Download source package or clone repository + - v1.0 - https://github.com/j123b567/scpi-parser/archive/v1.0.zip + - git clone https://github.com/j123b567/scpi-parser.git + +Go to the `libscpi` directory + +Build library, results are in `dist` folder + + make + +You can test library functions by + + make test + +You can use any of the examples in the `examples` directory + + Version history ---------------- Version v1.0 released 24.6.2013 @@ -13,13 +37,6 @@ - support all parameter types defined in the spec - separate them and identifie them - support for optional command headers (Richard.hmm) - - - - -[SCPI](http://en.wikipedia.org/wiki/Standard_Commands_for_Programmable_Instruments) Parser library aims to provide parsing ability of SCPI commands on instrument side. All commands are defined by its patterns eg: "STATus:QUEStionable:EVENt?". - -Source codes are published with open source Simplified BSD license. Command pattern definition ----------- -- Gitblit v1.9.1