Skip to content

Commit 54f63f4

Browse files
authored
Merge pull request #2 from KebanFiru/feat/implement_basic_usage
Added README for the project
2 parents d6639c6 + bc60891 commit 54f63f4

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# CodeCount
2+
3+
## Overview
4+
5+
CodeCount is a VS Code extension that counts lines of code in your workspace and shows stats in a dedicated view.
6+
7+
## Features
8+
9+
- Count total lines of code in the workspace.
10+
- Count lines per file and by file extension.
11+
- Refreshable stats view in the Activity Bar.
12+
13+
## Commands
14+
15+
- `CodeCount: Count Lines of Code`
16+
- `CodeCount: Count Lines of Code in All Files`
17+
- `CodeCount: Count Lines of Code by Extension`
18+
- `CodeCount: Refresh CodeCount Stats`
19+
20+
## Requirements
21+
22+
- VS Code 1.108.2 or newer.
23+
24+
## Usage
25+
26+
1. Open the Command Palette.
27+
2. Run one of the CodeCount commands.
28+
3. Open the CodeCount view in the Activity Bar to see stats.
29+
30+
## Contribution Guidelines
31+
32+
Thanks for taking the time to contribute! To keep changes consistent, please follow these steps:
33+
34+
1. Fork the repository and create a feature branch.
35+
2. Install dependencies with `npm install`.
36+
3. Build or watch the extension during development:
37+
- `npm run compile` for a one-time build
38+
- Press `F5` on [extension.ts](src/extension.ts) to launch the Extension Development Host.
39+
4. Run checks before opening a pull request:
40+
- `npm run lint`
41+
5. Open a pull request with a clear description of the change and any testing notes.
42+
43+

0 commit comments

Comments
 (0)