cline: README@7ded3ec4c417

     1                                        cline

     2                         _________________________________________

     3                              Copyright (C) 2013 Mike Becker

     5 Contents:

     6 1) About ................................................................... 13

     7 2) Build instructions ...................................................... 25

     8 3) Usage example ........................................................... 41

     9 4) Contact Information ..................................................... 50

    10 5) License ................................................................. 56

    13 1) About ______________________________________________________________________

    15 cline is a command line tool that counts code lines in your project folder. It

    16 is designed to recursively find any source file matching specific rules and

    17 count the line breaks within that file. You may specify file suffixes to include

    18 or exclude as well as regular expressions for code lines that shall be excluded

    19 (e.g. to exclude comments). By default a heuristic algorithm skips binary files.

    20 You may configure the restrictiveness of this algorithm with command line

    21 options.

    23 Type cline --help for further information.

    25 2) Build instructions _________________________________________________________

    27 To build cline with gcc navigate to the root directory of the project and type:

    28   make

    30 To rebuild cline type:

    31   make clean all

    33 To install cline type (as root):

    34   make install

    36 If you build cline with mingw under Windows, you need to type:

    37   make CONF=mingw

    38 or

    39   make CONF=mingw clean all

    41 3) Example usage ______________________________________________________________

    43 You can test cline right away with the cline project files. Just type:

    44   cline -rms .c,.h --exclude-cstyle-comments

    46 This will find any .c or .h file recursively in the cline project folder and

    47 won't display other files (-m option). It will also skip comments when counting

    48 lines.

    50 4) Contact Information ________________________________________________________

    52 You can contact us by either one of the following mail addresses:

    53   universe@uap-core.de   -   Direct developer contact

    54   info@uap-core.de       -   Generic mail address

    56 5) License ____________________________________________________________________

    58 Copyright 2013 Mike Becker. All rights reserved.

    60 Redistribution and use in source and binary forms, with or without

    61 modification, are permitted provided that the following conditions are met:

    63 1. Redistributions of source code must retain the above copyright

    64 notice, this list of conditions and the following disclaimer.

    66 2. Redistributions in binary form must reproduce the above copyright

    67 notice, this list of conditions and the following disclaimer in the

    68 documentation and/or other materials provided with the distribution.

    70 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    71 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    72 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

    73 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

    74 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

    75 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

    76 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

    77 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

    78 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    79 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Mercurial > hg > cline / file revision