Wed, 31 May 2017 11:40:07 +0200
replaces Makefiles with autoconf files
37 | 1 | cline |
2 | _________________________________________ | |
3 | Copyright (C) 2013 Mike Becker | |
4 | ||
5 | Contents: | |
46 | 6 | 1) About ................................................................... 12 |
7 | 2) Build instructions ...................................................... 24 | |
8 | 3) Usage example ........................................................... 40 | |
9 | 4) License ................................................................. 49 | |
37 | 10 | |
11 | ||
12 | 1) About ______________________________________________________________________ | |
13 | ||
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. | |
21 | ||
22 | Type cline --help for further information. | |
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 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
26 | To build cline with gcc navigate to the root directory of the project and type: |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
27 | make |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
28 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
29 | To rebuild cline type: |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
30 | make clean all |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
31 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
32 | To install cline type (as root): |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
33 | make install |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
34 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
35 | If you build cline with mingw under Windows, you need to type: |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
36 | make CONF=mingw |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
37 | or |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
38 | make CONF=mingw clean all |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
39 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
40 | 3) Example usage ______________________________________________________________ |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
41 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
42 | 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
|
43 | 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
|
44 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
45 | 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
|
46 | 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
|
47 | lines. |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
48 | |
46 | 49 | 4) License ____________________________________________________________________ |
37 | 50 | |
51 | Copyright 2013 Mike Becker. All rights reserved. | |
52 | ||
53 | Redistribution and use in source and binary forms, with or without | |
54 | modification, are permitted provided that the following conditions are met: | |
55 | ||
56 | 1. Redistributions of source code must retain the above copyright | |
57 | notice, this list of conditions and the following disclaimer. | |
58 | ||
59 | 2. Redistributions in binary form must reproduce the above copyright | |
60 | notice, this list of conditions and the following disclaimer in the | |
61 | documentation and/or other materials provided with the distribution. | |
62 | ||
63 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
64 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
65 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
66 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | |
67 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
68 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
69 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | |
70 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | |
71 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
72 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
46 | 73 |