Skip to content

Commit 5aba025

Browse files
committed
Add a basic README
1 parent 32f477c commit 5aba025

File tree

3 files changed

+40
-0
lines changed

3 files changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<h1 align="center">
2+
<img src="https://github.com/coderick14/ACedIt/blob/master/images/logo.png" width="500"/><br/>
3+
</h1>
4+
A command line tool to run your code against sample test cases. Without leaving the terminal :)
5+
6+
##### Installation
7+
+ `git clone https://github.com/coderick14/ACedIt`
8+
+ `cd ACedIt`
9+
+ `python setup.py install`
10+
11+
##### Usage
12+
```
13+
usage: ACedIt [-h] [-s SITE] [-c CONTEST] [-p PROBLEM] [-f]
14+
[--run SOURCE_FILE]
15+
16+
optional arguments:
17+
-h, --help show this help message and exit
18+
-s SITE, --site SITE The competitive programming platform, e.g. codeforces,
19+
codechef etc
20+
-c CONTEST, --contest CONTEST
21+
The name of the contest, e.g. JUNE17, LTIME49, COOK83
22+
etc
23+
-p PROBLEM, --problem PROBLEM
24+
The problem code, e.g. OAK, PRMQ etc
25+
-f, --force Force download the test cases, even if they are cached
26+
--run SOURCE_FILE Name of source file to be run
27+
28+
```
29+
30+
##### Supported sites
31+
+ Codeforces
32+
+ Codechef
33+
+ Spoj
34+
+ Hackerrank
35+
36+
##### Demo
37+
![ACedIt demo GIF](https://github.com/coderick14/ACedIt/blob/master/images/demo.gif "Simple demo of how ACedIt works" )
38+
39+
##### Note :
40+
There might be some issues with Spoj, as they have widely varying DOM trees for different problems. Feel free to contribute on this. Or anything else that you can come up with :)

images/demo.gif

441 KB
Loading

images/logo.png

38.2 KB
Loading

0 commit comments

Comments
 (0)