cline: README@7ded3ec4c417 (annotated)

README@7ded3ec4c417 (annotated)

README

Fri, 28 Dec 2012 17:15:23 +0100

author: Mike Becker <universe@uap-core.de>
date: Fri, 28 Dec 2012 17:15:23 +0100
changeset 38: 7ded3ec4c417
parent 37: cf65b0ddd030
child 46: e0928e4b9a59
permissions: -rw-r--r--

added build instructions and example to README

                                        cline
                         _________________________________________
                              Copyright (C) 2013 Mike Becker
 Contents:
 ) About ................................................................... 13
 ) Build instructions ...................................................... 25
 ) Usage example ........................................................... 41
 ) Contact Information ..................................................... 50
 ) License ................................................................. 56
 ) 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 _________________________________________________________
 To build cline with gcc navigate to the root directory of the project and type:
   make
 To rebuild cline type:
   make clean all
 To install cline type (as root):
   make install
 If you build cline with mingw under Windows, you need to type:
   make CONF=mingw
 or
   make CONF=mingw clean all
 ) 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.
 ) Contact Information ________________________________________________________
 You can contact us by either one of the following mail addresses:
   universe@uap-core.de   -   Direct developer contact
   info@uap-core.de       -   Generic mail address
 ) License ____________________________________________________________________
 Copyright 2013 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@7ded3ec4c417 (annotated)

README