Free Software Directory:Participate/Script aid
This script aims to help contributors on finding things that might be needed to consider during evaluation of the project/software.
As an extra precaution, an extra pass for other possible problematic words is made.
There is also a field for notes which is always left empty for the evaluator to do the appropriate observations or even insert marks of continuation for future resume of the review.
The output is in CSV format, making it suitable for parsing by other software, such as LibreOffice Calc, GNU R and even GNU Awk. For the last case, before doing so, set
\r\n, This variable setting was based on the related section in the GNU Awk User's Guide and on Awk's Texinfo/Info page.
In all cases, when importing, make sure that the selected language is English, so that "TRUE" and "FALSE" can be translated as correct boolean representation in your language of choice. Also, be aware of false-positives.
You're welcome to contribute to this script and add your name and contact information to the copyright notice of the script.
First, it's recommended to grant executable permissisns for your user, like so:
chmod u+x [path to FSD Script Aid.sh]
Then, take the complete corresponding source of the project being evaluated (e.g.: when using
git clone, you can accomplish this using the
git clone --recursive [Some git repository.] cd [Directory created by git] [Script aid.] > [Desired text file to store output.]; printf '\a'
printf '\a' can be replaced by a command to play an audio file of your choice.
Now leave the script to do its work and wait for the sound clue to continue working on the evaluation.
After this, you might be wondering: how to go exactly to the points where the script found something, on each file? For this purpose there is the
-p) option. It prints an extended regular expression (ERE) that can be reused by you in any text editor to look for the same things, per file.
For example, you can do this:
less -p "$([Script aid.] -p)" "file1" "file2" "fileN"
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.
The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.