Skip to content

Commit 5a315ce

Browse files
committed
Add README.md
1 parent badcd5f commit 5a315ce

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Codefetch
2+
3+
![Codefetch examples](./assets/codefetch.png)
4+
5+
Codefetch is a decorative program that displays [codeforces](https://codeforces.com) profiles on a terminal.
6+
7+
## Installation
8+
### Dependencies:
9+
- A [C++](https://isocpp.org/) compiler
10+
- [Make](https://www.gnu.org/software/make/manual/make.html) (optional)
11+
- [libcurl](https://curl.se/libcurl/)
12+
13+
To install, execute these:
14+
```bash
15+
git clone https://github.com/cMerd/codefetch.git
16+
mkdir build
17+
make
18+
sudo cp ./build/codefetch /usr/bin/codefetch
19+
```
20+
21+
## Usage
22+
```bash
23+
$ codefetch <handle>
24+
╭────────────────────────────────────╮
25+
│  Rank Handle │
26+
├────────────────────────────────────┤
27+
│  Full name: Name │
28+
│  From City, Country │
29+
│  At Organization │
30+
│  Rating: ____(max. ____, Rank) │
31+
│  Contribution: +___ │
32+
╰────────────────────────────────────╯
33+
```
34+
35+
### Note
36+
Colors don't work on windows.

assets/codefetch.png

254 KB
Loading

0 commit comments

Comments
 (0)