Project

General

Profile

Actions

Bug #122

closed

Unix tarball is missing some important files

Added by David Griffith about 12 years ago. Updated over 11 years ago.

Status:
Closed
Priority:
Normal
Category:
-
Target version:
Start date:
04/13/2012
Due date:
% Done:

0%

Estimated time:
3.00 h
Chirp Version:
0.2.2
Model affected:
(All models)
Platform:
Linux
Debug Log:
I read the instructions above:

Description

At the very minimum a README and INSTALL file should be present in the source tarball. AUTHORS would also be good. A Makefile would be nice too. I'll see what I can cook up tonight and report back.


Files

README (400 Bytes) README David Griffith, 05/07/2012 08:37 PM
INSTALL (1.2 KB) INSTALL David Griffith, 05/07/2012 08:37 PM
install.sh (140 Bytes) install.sh David Griffith, 05/07/2012 08:37 PM
uninstall.sh (316 Bytes) uninstall.sh David Griffith, 05/07/2012 08:37 PM
Actions #1

Updated by Dan Smith about 12 years ago

Python projects typically don't include a Makefile because there is no need. If you want to contribute a patch for the README, that would be great. The developer's mailing list is the right place to do that so we can discuss content. I'm not sure an AUTHORS file is really necessary at this point, and I know it will get stale quick.

Thanks!

Actions #2

Updated by David Griffith almost 12 years ago

Please take a look at these files and consider them for addition. README is finished. INSTALL requires some massaging by someone who more clearly understands what packages are needed with Redhat and similar systems. The install.sh and uninstall.sh files are quickies to make things easier for people who might not grok how Python packages are installed.

Actions #3

Updated by David Griffith almost 12 years ago

Oops. I forgot to update the INSTALL file completely after I added the install.sh and uninstall.sh files.

Actions #4

Updated by Dan Smith almost 12 years ago

  • Chirp Version changed from 0.2.1 to 0.2.2

The README is fine, and the INSTALL seems okay too, with the caveat below. I don't use these sorts of apps on RedHat/Fedora systems, so I can't check the dependencies for correctness. However, I expect your list is close enough.

Regarding the install scripts... CHIRP is a standard python program, and thus I feel strongly that installation of it should remain consistent with others. With the addition of your helpful INSTALL file (assuming we remove mention of these scripts and provide the proper command lines) I think just about any user will be able to figure it out. Further, the user can just run chirpw directly, or click on it from a UI file manager and get CHIRP running without installing.

Can you make these changes and submit to the development list as a proper mercurial patch? I can just dump these in and commit them, but I'd like for your name to be stamped on the changeset like the other developers if possible.

Thanks!

Actions #5

Updated by David Griffith almost 12 years ago

One of the reasons I created the uninstall.sh file is because the distribution includes files with spaces in them. This makes it tricky to delete all the installed files simply by doing "sudo rm $(cat files.txt)"

Actions #6

Updated by Tom Hayward over 11 years ago

  • Status changed from New to Closed

Looks like these changes made it into the repo about 4 months ago. Closing..

Actions

Also available in: Atom PDF