Skip to content

Commit faaf22e

Browse files
committed
Update README
1 parent 32dd794 commit faaf22e

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
</h1>
44
A command line tool to run your code against sample test cases. Without leaving the terminal :)
55

6-
##### Installation
6+
#### Installation
7+
##### Build from source
78
+ `git clone https://github.com/coderick14/ACedIt`
89
+ `cd ACedIt`
910
+ `python setup.py install`
1011

11-
##### Usage
12+
##### As a Python package
13+
`pip install ACedIt`
14+
15+
#### Usage
1216
```
1317
usage: ACedIt [-h] [-s SITE] [-c CONTEST] [-p PROBLEM] [-f]
1418
[--run SOURCE_FILE]
@@ -27,13 +31,33 @@ optional arguments:
2731
2832
```
2933

30-
##### Supported sites
34+
ACedIt requires the following working directory structure.
35+
```
36+
root-dir
37+
|
38+
|- Site1
39+
| |- Contest1
40+
| | |- Problem1
41+
| | |- Problem2
42+
| |- Contest2
43+
| | |- Problem1
44+
| | |- Problem2
45+
|- Site2
46+
| |- Contest1
47+
| | |- Problem1
48+
49+
```
50+
During installation, ACedIt will set up the basic working directory structure.
51+
While prefetching test cases, it will modify the same accordingly without any user intervention.
52+
But in case you're writing your code first and then using `ACedIt --run <source_file>`, make sure you follow the directory structure mentioned.
53+
54+
#### Supported sites
3155
+ Codeforces
3256
+ Codechef
3357
+ Spoj
3458
+ Hackerrank
3559

36-
##### Demo
60+
#### Demo
3761
![ACedIt demo GIF](https://github.com/coderick14/ACedIt/blob/master/images/demo.gif "Simple demo of how ACedIt works" )
3862

3963
##### Note :

0 commit comments

Comments
 (0)