Hamlib/README.developer

hamlib - (C) Frank Singleton 2000 (vk3fcs@ix.netcom.com)

General Guidelines.
-------------------

0. The top level directory looks like thus.

|-- RCS
|-- ft1000
|-- ft1000d
|-- ft747
|   |-- RCS
|   |-- include
|   |-- lib
|   `-- test
|       `-- RCS
|-- ft840
|-- ft847
|-- ft920
|-- ts570d
|-- ts870s
`-- ts950  

1.Every new shared lib should be created autonomously
  within its own directory. eg ft747/ for libft747.so

2. Every lib should have the following structure

ft747/
|-- Makefile
|-- RCS
|-- README.ft747
|-- TODO.ft747
|-- ft747.c
|-- ft747.h
|-- include
|-- lib
`-- test
    |-- Makefile
    |-- RCS
    |-- RESULT.example	
    |-- testlibft747.c
    `-- testlibft747.h 

3. Use the ft747 tree for examples of coding style. If there
   are any glaring problems,let me know..

4. The "test" directory should contain source code of the
   form testlibXXXX.[ch]

5. The "test" directory should build a test suite that
   excercises the API you are implementing.

6. libXXXX.so should be built to allow TX (PTT) to be disabled
   if required. See ft747.[ch] for how this is done.

7. The Makefile for the test suite should have a target like
   this to allow testing the API.

	# run test program in local directory
 
	.PHONY: runtest
	runtest:
        	(LD_LIBRARY_PATH="../lib" ./testlibft747 )  


8. You may wish to make an example out from your test suite
   program available as follows.

	make runtest > RESULT.example

9. Your header file (eg ft747.h, ft847.h etc) documents
   your API, so please describe it so others can understand.
   If this cannot be done, I may consider an "API.xxx" that
   decsribes the API (eg: API.ft747 )

10. ...