cline: README@68018eac46c3 (annotated)

README@68018eac46c3 (annotated)

README

Thu, 23 Aug 2018 19:45:36 +0200

author: Mike Becker <universe@uap-core.de>
date: Thu, 23 Aug 2018 19:45:36 +0200
changeset 57: 68018eac46c3
parent 53: 32b9e0a5cebd
child 63: 0b26266b8f51
permissions: -rw-r--r--

adds simple tiny test suite and updates license headers

                                        cline
                         _________________________________________
                              Copyright (C) 2018 Mike Becker
 Contents:
 ) About ................................................................... 12
 ) Build instructions ...................................................... 24
 ) Usage example ........................................................... 39
 ) License ................................................................. 48
 ) About ______________________________________________________________________
 cline is a command line tool that counts code lines in your project folder. It
 is designed to recursively find any source file matching specific rules and
 count the line breaks within that file. You may specify file suffixes to include
 or exclude as well as regular expressions for code lines that shall be excluded
 (e.g. to exclude comments). By default a heuristic algorithm skips binary files.
 You may configure the restrictiveness of this algorithm with command line
 options.
 Type cline --help for further information.
 ) Build instructions _________________________________________________________
 If you checked out the sources from version control, you firstly need to run
   ./prebuild.sh
 This requires autotools installed on your system.
 In release version you can skip the first task and just run
   ./configure && make
 After building you get a system wide install with
   sudo make install
 To enable a debug build, configure with
   ./configure --enable-debug
 ) Example usage ______________________________________________________________
 You can test cline right away with the cline project files. Just type:
   cline -rms .c,.h --exclude-cstyle-comments
 This will find any .c or .h file recursively in the cline project folder and
 won't display other files (-m option). It will also skip comments when counting
 lines.
 ) License ____________________________________________________________________
 Copyright 2018 Mike Becker. All rights reserved.
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 . Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
 . Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Mercurial > hg > cline / annotate

README@68018eac46c3 (annotated)

README