Wed, 22 May 2013 13:00:36 +0200
line sum per directory now displayed + directories without matching files are no longer displayed when -m is used + new buffering strategy replaces stream hack when -V is used
37 | 1 | cline |
2 | _________________________________________ | |
3 | Copyright (C) 2013 Mike Becker | |
4 | ||
5 | Contents: | |
38
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
6 | 1) About ................................................................... 13 |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
7 | 2) Build instructions ...................................................... 25 |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
8 | 3) Usage example ........................................................... 41 |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
9 | 4) Contact Information ..................................................... 50 |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
10 | 5) License ................................................................. 56 |
37 | 11 | |
12 | ||
13 | 1) About ______________________________________________________________________ | |
14 | ||
15 | cline is a command line tool that counts code lines in your project folder. It | |
16 | is designed to recursively find any source file matching specific rules and | |
17 | count the line breaks within that file. You may specify file suffixes to include | |
18 | or exclude as well as regular expressions for code lines that shall be excluded | |
19 | (e.g. to exclude comments). By default a heuristic algorithm skips binary files. | |
20 | You may configure the restrictiveness of this algorithm with command line | |
21 | options. | |
22 | ||
23 | Type cline --help for further information. | |
24 | ||
38
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
25 | 2) Build instructions _________________________________________________________ |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
26 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
27 | 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
|
28 | make |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
29 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
30 | To rebuild cline type: |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
31 | make clean all |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
32 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
33 | To install cline type (as root): |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
34 | make install |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
35 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
36 | 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
|
37 | make CONF=mingw |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
38 | or |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
39 | make CONF=mingw clean all |
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 | 3) Example usage ______________________________________________________________ |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
42 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
43 | 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
|
44 | 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
|
45 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
46 | 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
|
47 | 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
|
48 | lines. |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
49 | |
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
50 | 4) Contact Information ________________________________________________________ |
37 | 51 | |
52 | You can contact us by either one of the following mail addresses: | |
53 | universe@uap-core.de - Direct developer contact | |
54 | info@uap-core.de - Generic mail address | |
55 | ||
38
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
56 | 5) License ____________________________________________________________________ |
37 | 57 | |
58 | Copyright 2013 Mike Becker. All rights reserved. | |
59 | ||
60 | Redistribution and use in source and binary forms, with or without | |
61 | modification, are permitted provided that the following conditions are met: | |
62 | ||
63 | 1. Redistributions of source code must retain the above copyright | |
64 | notice, this list of conditions and the following disclaimer. | |
65 | ||
66 | 2. Redistributions in binary form must reproduce the above copyright | |
67 | notice, this list of conditions and the following disclaimer in the | |
68 | documentation and/or other materials provided with the distribution. | |
69 | ||
70 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
71 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
72 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
73 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | |
74 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
75 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
76 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | |
77 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | |
78 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
79 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
38
7ded3ec4c417
added build instructions and example to README
Mike Becker <universe@uap-core.de>
parents:
37
diff
changeset
|
80 |