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

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

mercurial