Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lcian committed May 12, 2024
1 parent ec225ec commit 99fdd18
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 14 deletions.
4 changes: 0 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ build:
clean:
rm -f cf

.PHONY: install
install: build
go install

.PHONY: fmt
fmt:
gofmt -s -l -w .
Expand Down
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Codeforces CLI is a command-line interface tool for the competitive programming

It's fast, small, cross-platform and powerful.

This is a fork of the original repo [xalanq/cf-tool](https://github.com/xalanq/cf-tool) which is no longer maintained.

Feel free to open an issue/pull request if you find any bugs or have any suggestions for features to add!

[Installation](#installation) | [Usage](#usage) | [FAQ](#faq)

## Features
Expand All @@ -28,30 +32,21 @@ It's fast, small, cross-platform and powerful.
* Setup a network proxy. Setup a mirror host.
* Colorful CLI.

Pull requests are always welcome.

![](./assets/readme_1.gif)

## Installation

You can download the pre-compiled binary file in [here](https://github.com/lcian/codeforces-cli/releases).

Or you can use `go install`:

```sh
go install github.com/lcian/codeforces-cli@latest
```

Or you can compile it from source **(go >= 1.22)**:

```sh
git clone https://github.com/lcian/codeforces-cli.git
cd codeforces-cli
make
make install
```

This will install the `cf` binary to your `$GOPATH/bin` directory.
This will create a `cf` binary that you can move somewhere in your $PATH.

## Usage

Expand Down

0 comments on commit 99fdd18

Please sign in to comment.