lcc/README.md

32 lines
1 KiB
Markdown
Raw Permalink Normal View History

2024-05-17 11:28:47 +02:00
# lcc
Fast lines of code counter.
2024-05-17 11:28:47 +02:00
2024-05-19 02:49:57 +02:00
# Usage
```sh
lcc <path> <path2> <path3> - Count lines of code in supplied paths(no argument would be considered counting in current directory)
2024-05-19 02:49:57 +02:00
```
# Dependencies
2024-05-22 11:55:17 +02:00
None
2024-05-19 02:49:57 +02:00
# Building
You will need to run these with elevated privilages.
2024-05-22 11:55:17 +02:00
```
2024-05-19 02:49:57 +02:00
$ make
# make install
```
# Customizing
You can modify `lcc.h` to add more languages to count lines, with the same format as provided in the file.
You can also add directories name and file extensions to ignore when counting lines, but the length of `ignore_dir` must be matching `IGNORE_DIRS`.
# Warning
2024-05-19 15:18:21 +02:00
Result may not be 100% correct due to coding style, but from testing, code with [suckless coding style](https://suckless.org/coding_style) will be most accurate due to different method of commenting in code.
2024-05-17 11:28:47 +02:00
# Contributions
Contributions are welcomed, feel free to open a pull request.
# License
This project is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/lcc/blob/master/LICENSE) for more information.