cline: README@ed9a5ffd1f13

     1                                        cline

     2                         _________________________________________

     3                              Copyright (C) 2018 Mike Becker

     5 Contents:

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

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

     8 3) Usage example ........................................................... 35

     9 4) License ................................................................. 44

    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 When you want to build from source, you can just run

    27   make

    29 After building you get a system wide install with

    30   sudo make install

    32 To enable a debug build, configure with

    33   ./configure --debug

    35 3) Example usage ______________________________________________________________

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

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

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

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

    42 lines.

    44 4) License ____________________________________________________________________

    46 Copyright 2018 Mike Becker. All rights reserved.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Mercurial > hg > cline / file revision