cline: README@e0928e4b9a59

     1                                        cline

     2                         _________________________________________

     3                              Copyright (C) 2013 Mike Becker

     5 Contents:

     6 1) About ................................................................... 12

     7 2) Build instructions ...................................................... 24

     8 3) Usage example ........................................................... 40

     9 4) License ................................................................. 49

    12 1) About ______________________________________________________________________

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

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

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

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

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

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

    20 options.

    22 Type cline --help for further information.

    24 2) Build instructions _________________________________________________________

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

    27   make

    29 To rebuild cline type:

    30   make clean all

    32 To install cline type (as root):

    33   make install

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

    36   make CONF=mingw

    37 or

    38   make CONF=mingw clean all

    40 3) Example usage ______________________________________________________________

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

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

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

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

    47 lines.

    49 4) License ____________________________________________________________________

    51 Copyright 2013 Mike Becker. All rights reserved.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Mercurial > hg > cline / file revision