README

Tue, 10 Oct 2023 20:34:51 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 10 Oct 2023 20:34:51 +0200
changeset 74
ed9a5ffd1f13
parent 68
ae763178ee1e
permissions
-rw-r--r--

update uwproj (adds support for config.site)

universe@37 1 cline
universe@37 2 _________________________________________
universe@57 3 Copyright (C) 2018 Mike Becker
universe@37 4
universe@37 5 Contents:
universe@46 6 1) About ................................................................... 12
universe@46 7 2) Build instructions ...................................................... 24
universe@68 8 3) Usage example ........................................................... 35
universe@68 9 4) License ................................................................. 44
universe@37 10
universe@37 11
universe@37 12 1) About ______________________________________________________________________
universe@37 13
universe@37 14 cline is a command line tool that counts code lines in your project folder. It
universe@37 15 is designed to recursively find any source file matching specific rules and
universe@37 16 count the line breaks within that file. You may specify file suffixes to include
universe@37 17 or exclude as well as regular expressions for code lines that shall be excluded
universe@37 18 (e.g. to exclude comments). By default a heuristic algorithm skips binary files.
universe@37 19 You may configure the restrictiveness of this algorithm with command line
universe@37 20 options.
universe@37 21
universe@37 22 Type cline --help for further information.
universe@37 23
universe@38 24 2) Build instructions _________________________________________________________
universe@38 25
universe@68 26 When you want to build from source, you can just run
universe@68 27 make
universe@38 28
universe@48 29 After building you get a system wide install with
universe@48 30 sudo make install
universe@38 31
universe@48 32 To enable a debug build, configure with
universe@68 33 ./configure --debug
universe@38 34
universe@38 35 3) Example usage ______________________________________________________________
universe@38 36
universe@38 37 You can test cline right away with the cline project files. Just type:
universe@38 38 cline -rms .c,.h --exclude-cstyle-comments
universe@38 39
universe@38 40 This will find any .c or .h file recursively in the cline project folder and
universe@38 41 won't display other files (-m option). It will also skip comments when counting
universe@38 42 lines.
universe@38 43
universe@46 44 4) License ____________________________________________________________________
universe@37 45
universe@57 46 Copyright 2018 Mike Becker. All rights reserved.
universe@37 47
universe@37 48 Redistribution and use in source and binary forms, with or without
universe@37 49 modification, are permitted provided that the following conditions are met:
universe@37 50
universe@37 51 1. Redistributions of source code must retain the above copyright
universe@37 52 notice, this list of conditions and the following disclaimer.
universe@37 53
universe@37 54 2. Redistributions in binary form must reproduce the above copyright
universe@37 55 notice, this list of conditions and the following disclaimer in the
universe@37 56 documentation and/or other materials provided with the distribution.
universe@37 57
universe@37 58 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@37 59 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@37 60 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
universe@37 61 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
universe@37 62 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
universe@37 63 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
universe@37 64 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
universe@37 65 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
universe@37 66 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
universe@37 67 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
universe@46 68

mercurial