Skip to content

Commit 117bff1

Browse files
committed
fix #18: fix README
1 parent 0b4adcb commit 117bff1

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

+21-7
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,34 @@ and help execute tests locally via their favorite programming language.
77

88
## Installation
99

10-
- The installation requires that you have `go` installed, and you just type `go get github.com/chermehdi/go-egor`
11-
and you will have the go-egor command available to you.
10+
- There is actually two ways for installing egor.
11+
12+
### Download compiled binary
13+
- You can download the binary that corresponds to your operating system and add it to your `PATH` variable, you can find the binaries in the [releases](https://github.com/chermehdi/go-egor/releases) page.
14+
- For people running Mac OSX Catalina, this won't work and you will be forced to go with the Build from source solution.
15+
16+
### Build from source
17+
- You can clone the repository, and have go installed in your machine
18+
- Navigate to the directory of the cloned project and run `go build` to build the project, and `go install` to install it to your local machine, the binary can then be found in `$GOOPATH/bin/egor`
1219

1320
## Features
1421

1522
- The current supported command list is outlined here, and you can find out more details in the docs page.
16-
- `go-egor parse`: Starts listening for competitive companion chrome plugin to parse the task
17-
- `go-egor test`: Runs the tests of the current task and outputs the results
18-
- `go-egor copy`: Copies the current task to the clipboard.
19-
- `go-egor batch`: Tests the main solution for this task against another solution (probably written in another language than the main one)
23+
- `egor parse`: Starts listening for competitive companion chrome plugin to parse the task
24+
- `egor test`: Runs the tests of the current task and outputs the results
25+
- `egor config`: Read/Change global configuration parameters.
26+
- `egor testcase`: Add a custom test case to this egor task.
27+
- `egor showcases`: list meta data abou the tests in the current task
28+
- `egor printcase`: Print input and or output of a given test case
29+
- `egor copy`: Copies the current task to the clipboard.
30+
- `egor help`: Display help for command.
31+
- `egor batch (in developement)`: Tests the main solution for this task against another solution (probably written in another language than the main one)
2032
by running both of them and feeding them the tests for this task, this is usefull if you have a brute force solution and an efficient solution
2133
and you want to validate the optimal solution against the one you are sure that is working.
2234

2335
## Contribution
2436

25-
- Contribution of any kind is welcome, Testing, Issues and Pull requests 😄
37+
- Contribution to the project can be done in multiple ways, you can report bugs and issues or you can discuss new features that you like being added in future versions by adding a new issue
38+
and tagging one of the maintainers, and if you have the time and have ideas about how you can integrate your feature, it's always a good idea to back your feature request with a PR (but it's fine if you can't 😅)
2639

40+
- PR's opened should mention one of the maintainers as a reviewer, and shouldn't break the current test suit.

0 commit comments

Comments
 (0)