newdriver: Drop obsolete checks and code chunks.
[sigrok-util.git] / source / README.new-driver
1 The 'new-driver' script is meant to reduce the "red tape" involved in creating
2 a new hardware driver for sigrok. It checks out a new copy of libsigrok from
3 the git repository, makes entries in the build system for your device, and
4 creates source code stubs to help you get started.
5
6 If you're writing a driver for a new multimeter (DMM) called the
7 'Flupe Goodluck', invoke the script like this:
8
9         ./new-driver Flupe Goodluck
10
11 The output will show something like this:
12
13 Cloning into 'libsigrok'...
14 [master d5f915f] flupe-goodluck: initial driver skeleton
15  6 files changed, 321 insertions(+)
16  create mode 100644 hardware/flupe-goodluck/api.c
17  create mode 100644 hardware/flupe-goodluck/protocol.c
18  create mode 100644 hardware/flupe-goodluck/protocol.h
19 0001-flupe-goodluck-initial-driver-skeleton.patch
20
21 The last line shows the name of the patch file that's created for you. It's
22 a proper git mail patch, and can be applied to your tree like this:
23
24 cd /some/path/libsigrok
25 git am /some/place/0001-flupe-goodluck-initial-driver-skeleton.patch
26