#
# README file - Terminocheck
# Copyright (C) 2016 Felicien PILLOT <felicien.pillot@member.fsf.org>
# type $PATH/terminocheck --version for more details

Terminocheck (as in Terminological checker) is a Perl script which lets
you check and rectify terminological mistakes in source code, such as
using Linux instead of GNU/Linux.

Terminocheck is free software: you can redistribute it and/or modify
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

================ QUICK INSTALL ==================

Copy or symlink the file "terminocheck.pl" in /usr/local/bin, or add
the current directory into your PATH:

  # cp $PACKAGE_DIR/terminocheck.pl /usr/local/bin/terminocheck
  OR
  # ln -s $PACKAGE_DIR/terminocheck.pl /usr/local/bin/terminocheck
  OR
  $ export PATH=$PATH:$PACKAGE_DIR

-> PACKAGE_DIR is the directory which contains terminocheck (and this
file) initially.
See below for running instructions

================ QUICK TEST =====================

You can test Terminocheck before running it on your own files, so you
see its features and limits:

  $ terminocheck.pl -r $PACKAGE_DIR/examples

-> PACKAGE_DIR is the directory which contains terminocheck (and this
file) initially.

================ SOME EXPLANATIONS ===============

If you don't understand the need of this script, because it doesn't
seem important to you to be that specific and persnickety, please
read the ABOUT file, which contains some articles from www.gnu.org
that explain very well our point of view.

This script has been first created because of a request from people
from http://help.riseup.net: switch all occurences of 'Linux' in
their documentation to 'GNU/Linux'.

It could have been done with sed or something like that, or even a
simple Perl script with recursion in interpreter's command line, but
we wanted to make a dynamic and reusable script, which would offer to
the user the possibility to examine the context of the occurence,
check if replacement is appropriated (for example if text speaks about
the Linux kernel), etc.

It is also only at its begginning of developpement, we hope it will
be able to do much more things in the future (for example, scan into
a git repository to evaluate the amount of rectification it have to
be done there, etc.).

Any comment or contribution is welcome, see at the bottom of this
page for that.

================ RUNNING INSTRUCTIONS ============

usage: [perl] $PATH/terminocheck.pl [OPTIONS] [FILES]

options:
-b, --bad-term=STRING
    Set the wrong/inappropriated term to STRING, default value is 'linux'
-g, --good-term=STRING
    Set the right/appropriated term to STRING, default value is 'GNU/Linux'
-h, --help
    Display this help and exit
    --no-confirm
    Do not ask confirmation (use it carefully)
-r, --recursive=DIR
    Process all files recursively in DIR
-v, --verbose
    Increase verbosity (useful information about process		
    --version
    Display version and copyright information and exit

================ OTHER STUFF WE WANTED TO SAY ====

The only dependance is Perl (>5.1)
Terminal with ANSI colors supported is also required when using the
script without --nocolor option.

Look at TODO file for details about future developpment

For more informations, or to give us help or comments -- it can be about
language, we know we can make some mistakes, as we are (I am) french --
please contact me at <felicien dot pillot at riseup dot net>
