From 5d539dcb029bb3088b3c3824962a46cebaf6f096 Mon Sep 17 00:00:00 2001 From: "Nate Bargmann, N0NB" Date: Thu, 28 Jan 2010 22:44:56 +0000 Subject: [PATCH] Update copyright date. Revise documents as needed for Wiki. git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@2819 7ae35d74-ebe9-4afe-98af-79ac388436b8 --- README | 119 ++++++++++++++++++++++++++--------------------- README.developer | 2 +- README.release | 96 ++++++++++++++++++++------------------ 3 files changed, 119 insertions(+), 98 deletions(-) diff --git a/README b/README index 4963165eb..795751d59 100644 --- a/README +++ b/README @@ -1,98 +1,111 @@ Hamlib - (C) Frank Singleton 2000 (vk3fcs@ix.netcom.com) (C) Stephane Fillod 2000-2007 - (C) The Hamlib Group 2000-2009 + (C) The Hamlib Group 2000-2010 -The purpose of this project is to provide stable, flexible, -shared libraries that enable quicker development of Amateur -Radio Equipment Control Applications. - -Many Amateur Radio Transceivers come with serial interfaces -that allows software to control the radio. This project will -endeavour to provide shared libraries that greatly simplify -the application programmer's interaction with radio equipment -and other controllable devices such as rotators, switches, etc. +The purpose of this project is to provide stable, flexible, shared libraries +that enable quicker development of Amateur Radio Equipment Control +Applications. + +Many Amateur Radio Transceivers come with serial interfaces that allows +software to control the radio. This project will endeavour to provide shared +libraries that greatly simplify the application programmer's interaction with +radio equipment and other controllable devices such as rotators, switches, etc. + +Supported Radios +---------------- + +The Hamlib Wiki page, Supported Radios, contains a snapshot of the supported +radio at the time of the last Hamlib release. Go to http://www.hamlib.org +to reach the Wiki. + +Hamlib Design +------------- The shared libs will provide functions for both radio control, and data retrieval from the radio. - + The structure of the libraries will be as follows. -(1) There will be 1 frontend library "libhamlib" that - provides the generic API for user applications. +(1) There will be 1 frontend library "libhamlib" that + provides the generic API for user applications. -(2) There will be "n" backend libraries that "wrap" - rig specific communications inside frontend API. +(2) There will be "n" backend libraries that "wrap" + rig specific communications inside frontend API. -(3) Frontend lib will load (on demand) the appropriate - backend lib as required. +(3) Frontend lib will load (on demand) the appropriate + backend lib as required. Frontend Library ---------------- libhamlib.so - frontend lib that provides generic API - for all RIG types. This is what Application - programmers will "see". + for all RIG types. This is what Application + programmers will "see". Backend Examples are: --------------------- - + 1.hamlib-yaesu.so will provide connectivity to Yaesu FT 747GX Transceiver, FT 847 "Earth Station", etc. via a standard API. 2. hamlib-xxxx.so will provide connectivity to the Wiz-bang moon-melter 101A (yikes..) -Hamlib will also enable developers to develop professional looking GUI's -towards a standard control library API, and they would not have to worry +Hamlib will also enable developers to develop professional looking GUI's +towards a standard control library API, and they would not have to worry about the underlying connection towards physical hardware. - -Initially serial (RS232) connectivity will be handled, but -I expect that IP (and other) connectivity will follow afterwards. + +Initially serial (RS232) connectivity will be handled, but we expect that IP +(and other) connectivity will follow afterwards. Connection via a USB port +is accomplished via the Linux kernel support. USB to serial converters are +well supported. Other such devices may be supported as long as they present +a serial (RS-232) interface to Hamlib. Recompiling ----------- -Hamlib is entirely developped using GNU tools, under various Linux systems. -That is, if you want to take part in the development of Hamlib, -you'll need at least the following tools: - * autoconf > 2.50 - * automake > 1.7 - * libtool > 1.5 - * doxygen - * cvs and ssh to connect to http://sourceforge.net/ +Hamlib is entirely developed using GNU tools, under various Linux systems. +That is, if you want to take part in the development of Hamlib, you'll need +at least the following tools: + * autoconf > 2.54 + * automake > 1.7 + * libtool > 1.5|2.2.6 + * doxygen + * svn and ssh to connect to http://sourceforge.net/ -There are also the README.betatester and README.developer files in this -directory if you feel like hacking hamlib. Otherwise, contributions of rig -specifications and protocol documentation are highly encouraged. Do keep -in mind that in some cases the manufacturer may not provide complete control -information or it is only available under a Non-Disclosure Agreement (NDA). -Any documentation *must* be publically available so we can legally write and -distribute Free Software supporting a given device. +There are also the README.betatester and README.developer files in this +directory if you feel like testing or hacking Hamlib. Otherwise, contributions +of rig specifications and protocol documentation are highly encouraged. Do +keep in mind that in some cases the manufacturer may not provide complete +control information or it is only available under a Non-Disclosure Agreement +(NDA). Any documentation *must* be publicly available so we can legally write +and distribute Free Software supporting a given device. -However, if you just want to recompile the library, please refer -to the INSTALL file. +However, if you just want to recompile the library, please refer to the INSTALL +and README.betatester files. -IMPORTANT: If autoconf or automake are installed on your system, make sure -they are matching *at least* the version shown above. The Hamlib team is +IMPORTANT: If autoconf or automake are installed on your system, make sure +they are matching *at least* the version shown above. The Hamlib team is very interrested to hear from you, how Hamlib builds and works on your system, -especially on non-Linux system or non-PC systems. We try to make Hamlib as +especially on non-Linux system or non-PC systems. We try to make Hamlib as portable as possible. Please report in case of problems at hamlib-developer@lists.sourceforge.net Patches are welcome too! -And for those who were brave enough to read until here, but not lucky enough -to rebuild the lib, there is good news. The RPM and deb packages are -available at the sourceforge.net site. Enjoy! +Most distributions have the latest Hamlib release in their testing or alpha +versions of their distribution. Check your package manager for the Hamlib +version included in your distribution. -Take a look at tests/README for more info on simple examples. +Take a look at tests/README for more info on simple programming examples and +test programs. Also, take a look at http://sourceforge.net/projects/hamlib/ -Here you will find a mail list, and the latest releases. -Feedback, questions, etc. about Hamlib are very welcome -at the mail list: +Here you will find a mail list, and the latest releases. Feedback, questions, +etc. about Hamlib are very welcome at the mail list: + -Have Fun / Frank S / Stephane F +Have Fun / Frank S / Stephane F / The Hamlib Group 73's de vk3fcs/km5ws / f8cfe diff --git a/README.developer b/README.developer index 0747f2e62..2152e3adf 100644 --- a/README.developer +++ b/README.developer @@ -1,6 +1,6 @@ Hamlib - (C) Frank Singleton 2000 (vk3fcs@ix.netcom.com) (C) Stephane Fillod 2000-2007 - (C) The Hamlib Group 2000-2009 + (C) The Hamlib Group 2000-2010 Take a look at http://sourceforge.net/projects/hamlib/ Here you will find a mail list, and the latest SVN releases. diff --git a/README.release b/README.release index 69b9ef88a..2c8999cf3 100644 --- a/README.release +++ b/README.release @@ -7,49 +7,61 @@ TODO: With the switch to SVN SCM discuss the use of tags and branches Before deciding release: ----------------------- -* Anticipate what problems would experience users with the new release, +* Anticipate what problems would users experience with the new release, so you can fix the problems before making the release. Basically, this is making sure the package will compile on a whole breed of systems (arch,OS,library,gcc,etc. combo), that there's no regression, and the API evolution is managed well. -* Announce CVN/version freeze on hamlib-developer mailing list, + +* Announce SVN/version freeze on hamlib-developer mailing list, so developers have time to check in their contributions. + * Update libtool: - macros/{ltdl,libtool}.m4 - ltmain.sh - libltdl/ - A postfix of libtool in libltdl/Makefile.in may be needed: empty am__aclocal_m4_deps + macros/{ltdl,libtool}.m4 + ltmain.sh + libltdl/ + A postfix of libtool in libltdl/Makefile.in may be needed: empty am__aclocal_m4_deps Releasing Hamlib: ---------------- * Update NEWS, TODO, AUTHORS -* Update the version in the macro AC_INIT of configure.ac + +* Update the version in the macro AC_INIT of configure.ac (remove 'svn') + * Regenerate ChangeLog with: - TZ=UTC svn2cl + TZ=UTC svn2cl + * Tag the SVN rep with version 'HAMLIB-x-y-z' + * Build source tarball: - svn co https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk hamlib + svn co https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk hamlib sh autogen.sh --enable-maintainer-mode - make dist + + # (Would the above command be better invoked as: + # sh autogen.sh --disable-maintainer-mode --prefix=/usr/local CFLAGS="-g -O0" + # ?? comments please.) + + make dist + * Build Windows DLL from previous tarball, and .LIB, then create .zip file Rem: under Linux, you need the package mingw32 to cross-compile it, and free MVC++Toolkit to create .lib file: - ./configure --disable-static \ - --host=i586-mingw32msvc \ - --prefix=/tmp/mingw-inst \ - --without-rpc-backends \ - --without-perl-binding --without-tcl-binding --without-python-binding \ - --enable-xmltest ac_cv_path_PKG_CONFIG=no - make install - mkdir -p /tmp/mingw-inst/hamlib-x.y.z/lib/msvc - cp src/libhamlib.def /tmp/mingw-inst/hamlib-x.y.z/lib/msvc/libhamlib-2.def - cd /tmp/mingw-inst/hamlib-x.y.z/lib/msvc/ - unix2dos include/hamlib/*.h - unix2dos ./lib/msvc/*.def - wine /media/sda1/Program\ Files/Microsoft\ Visual\ C++\ Toolkit\ 2003/bin/link.exe /lib /machine:i386 /def:libhamlib-2.def - vi README.win32.mine - zip -r hamlib-win32-x.y.z.zip hamlib-x.y.z - Edit Release, i386, .zip + ./configure --disable-static \ + --host=i586-mingw32msvc \ + --prefix=/tmp/mingw-inst \ + --without-rpc-backends \ + --without-perl-binding --without-tcl-binding --without-python-binding \ + --enable-xmltest ac_cv_path_PKG_CONFIG=no + make install + mkdir -p /tmp/mingw-inst/hamlib-x.y.z/lib/msvc + cp src/libhamlib.def /tmp/mingw-inst/hamlib-x.y.z/lib/msvc/libhamlib-2.def + cd /tmp/mingw-inst/hamlib-x.y.z/lib/msvc/ + unix2dos include/hamlib/*.h + unix2dos ./lib/msvc/*.def + wine /media/sda1/Program\ Files/Microsoft\ Visual\ C++\ Toolkit\ 2003/bin/link.exe /lib /machine:i386 /def:libhamlib-2.def + vi README.win32.mine + zip -r hamlib-win32-x.y.z.zip hamlib-x.y.z + Edit Release, i386, .zip * Build Windows DLL with stdcall convention: Ditto but with HAMLIB_API set to __stdcall in include/hamlib/rig_dll.h before re-compiling. @@ -60,36 +72,32 @@ Releasing Hamlib: [Add release] "x-y-z" Paste NEWS section and ChangeLog, select file, change file processor type to "Any"/"Source .gz" and notify users. -* Update http://hamlib.org web pages + +* Update http://www.hamlib.org Wiki - Download section - hamlib.org: html.hamlib/{manual,news,download}.html - svn commit - wsmake - scp *.html shell.sourceforge.net:/home/groups/h/ha/hamlib/htdocs/. - support.html - Documentation (requires doxygen) - make -C doc doc - ssh shell.sourceforge.net mkdir /home/groups/h/ha/hamlib/htdocs/manuals/x-y-z - scp -r doc/html shell.sourceforge.net:/home/groups/h/ha/hamlib/htdocs/manuals/x-y-z/. - $EDIT manuals.html + make -C doc doc + ssh shell.sourceforge.net mkdir /home/groups/h/ha/hamlib/htdocs/manuals/x-y-z + scp -r doc/html shell.sourceforge.net:/home/groups/h/ha/hamlib/htdocs/manuals/x-y-z/. + Edit Wiki Documentation section - Supported Radios/Rotators - make -C tests rigmatrix.html - scp -r tests/sup-info/* shell.sourceforge.net:/home/groups/h/ha/hamlib/htdocs/sup-info/. + make -C tests rigmatrix.html + scp -r tests/sup-info/* shell.sourceforge.net:/home/groups/h/ha/hamlib/htdocs/sup-info/. + * Notify various sites: - Sourceforge/News: https://sourceforge.net/news/submit.php?group_id=8305 - Freshmeat: http://freshmeat.net/projects/hamlib - http://radio.linux.org.au/pkgdetail.phtml?pkgid=243 Linux Hamradio App: rigctl category -* Send announce to mailing list: [ANN] hamlib-announce, linux-ham + +* Send announce to mailing lists: [ANN] hamlib-announce, linux-ham To advertise: -- list the rigs supported so far, +- list the rigs supported so far, - what was major work achieved, -- where we're heading, +- where we're heading, - what kind of support we need - Get ready for the next round: * Bump version number and append 'svn' to it in macro AC_INIT of configure.ac + * Update src/Makefile.am revision of -version-info - -