[chirp_devel] [PATCH] Adding INSTALL, README, and README.support files

[David Griffith]

On Wed, 9 May 2012, Tom Hayward wrote:

> On Wed, May 9, 2012 at 7:30 AM, Dan Smith <dsmith at danplanet.com> wrote:
>>> I don't think README.support should be distributed like this. I'd prefer
>>> to give them a script that will output the current list, so we don't
>>> have to maintain another file.
>>
>> I agree, and I think I said that in the last round where this was
>> presented. The "make_supported.py" script already does this (and much
>> more), so I'd rather have the file say "run that if you're interested".
>
> I wouldn't mind instructions for how to run this in the README. I
> always forget :-)

Okay, here's an updated patch.  README.support is eliminated and README 
has instructions to run "python share/make_supported.py > radios.html".

# HG changeset patch
# User David Griffith <dave at 661.org>
# Date 1336591163 25200
# Node ID e2857fd2d5e7c41d522f3d31fa291986055ad9cb
# Parent  24cb2e48098df646010797cdd3e4664f6b6513c5
New README and INSTALL files

diff -r 24cb2e48098d -r e2857fd2d5e7 INSTALL
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL	Wed May 09 12:19:23 2012 -0700
@@ -0,0 +1,44 @@
+This file describes the installation of Chirp without package management 
+on Linux and other Unix-like operating systems.  This sort of thing may 
+be your only choice because 1) a package has not yet been made for your 
+OS or distribution, 2) the packaged version is obsolete, or 3) you want 
+to try a daily build.
+
+
+For Debian, Ubuntu, and related systems, the following packages are required:
+python
+python-gtk2
+python-libxml2
+python-libxslt1
+python-serial
+python-support
+
+For Redhat, Fedora, CentOS and related systems, the following packages 
+are required: (This list is incomplete.  Please submit corrections.)
+python
+pygtk2
+libxml2-python
+python-libxslt
+
+
+Once these packages are installed, you can run Chirp directly from the 
+distribution directory by typing "./chirpw".  If you want to install it 
+properly, type this:
+
+  sudo python setup.py install --record files.txt
+
+This will install the package and create a list of files that were 
+added to your system.  If you want to deinstall Chirp, type this: 
+
+  sudo xargs -0 rm -rf < files.txt
+
+This will cause rm(1) to take its list of arguments from the file named 
+"files.txt" and remove those files from the system.  If you forgot to 
+create "files.txt", you can simply reinstall the way it is shown here 
+and continue on your way.
+
+Note: This will not uninstall directories created by the installation of 
+Chirp.  Presence of these empty directories shouldn't be a problem, but 
+if they are, it's easy to go through the files.txt file, identify them, 
+and remove them.
+
diff -r 24cb2e48098d -r e2857fd2d5e7 README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Wed May 09 12:19:23 2012 -0700
@@ -0,0 +1,16 @@
+Chirp is a free, open-source, multiplatform tool for programming your 
+amateur radio. It supports a large number of manufacturers and models, 
+as well as provides a way to interface with multiple data sources and 
+formats.
+
+Complete documentation may be found at the Chirp website at 
+http://chirp.danplanet.com/projects/chirp
+
+For a list of radios supported by Chirp, type the following command:
+
+  python share/make_supported.py > radios.html
+
+This will generate an HTML file containing a rundown of all the 
+currently supported radios and a matrix of what features are supported 
+for which radio.
+