Skip to content

Commit 4ad0eae

Browse files
coderick14coderick14
committed
Update README
1 parent d94e455 commit 4ad0eae

File tree

2 files changed

+59
-41
lines changed

2 files changed

+59
-41
lines changed

‎README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@
66
</h1>
77
A command line tool to run your code against sample test cases. Without leaving the terminal :)
88

9+
#### Demo
10+
![ACedIt demo GIF](https://github.com/coderick14/ACedIt/blob/master/images/demo.gif "Simple demo of how ACedIt works" )
11+
12+
#### Supported sites
13+
+ Codeforces
14+
+ Codechef
15+
+ Spoj
16+
+ Hackerrank
17+
918
#### Installation
1019
##### Build from source
1120
+ `git clone https://github.com/coderick14/ACedIt`
@@ -44,7 +53,7 @@ optional arguments:
4453
```
4554
During installation, the default site is set to `codeforces` and the default working directory is set to `/home/your-username/ACedIt`. You can change them anytime using the above mentioned flags.
4655

47-
ACedIt requires the following working directory structure.
56+
ACedIt requires the following working directory structure **(Recommended)**. It also has the added advantage of keeping your work organized :)
4857
```
4958
workdir
5059
|
@@ -63,14 +72,11 @@ workdir
6372
6473
```
6574
During installation, ACedIt will set up the basic working directory structure.
66-
While prefetching test cases, it will modify the same accordingly without any user intervention.
67-
But in case you're writing your code first and then using `ACedIt --run <source_file>`, make sure you follow the directory structure mentioned.
75+
While prefetching test cases, it will modify the same accordingly without any user intervention.
6876

69-
#### Supported sites
70-
+ Codeforces
71-
+ Codechef
72-
+ Spoj
73-
+ Hackerrank
77+
***But in case you're writing your code in some other directory, you can use `ACedIt --run <SOURCE_FILE> -s SITE -c CONTEST -p PROBLEM`. You can omit `-s` as it'll take the default site.***
78+
79+
***But there's no need to specify the `-s`, `-c` and `-p` flags if you follow the above mentioned directory structure (ACedIt will create most of it for you on the fly :)***
7480

7581
#### Examples
7682
+ Fetch test cases for a single problem
@@ -85,16 +91,20 @@ ACedIt -s codechef -c AUG17
8591
```
8692
ACedIt -s codeforces -c 86 -p D -f
8793
```
88-
+ Test your code against sample cases
94+
+ Test your code against sample cases (when following the recommended directory structure)
8995
```
9096
ACedIt --run D.cpp
9197
```
9298
```
9399
ACedIt --run CHEFFA.py
94100
```
95-
96-
#### Demo
97-
![ACedIt demo GIF](https://github.com/coderick14/ACedIt/blob/master/images/demo.gif "Simple demo of how ACedIt works" )
101+
+ Test your code against sample cases (from any other directory)
102+
```
103+
ACedIt --run solve.cpp -c 835 -p D
104+
```
105+
```
106+
ACedIt --run test.py -s codechef -c AUG17 -p CHEFFA
107+
```
98108

99109
##### Note :
100110
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 :)

‎README.rst

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,21 @@
1212

1313
</h1>
1414

15-
A command line tool to run your code against sample test cases. Without
16-
leaving the terminal :)
15+
A command line tool to run your code against sample test cases. Without leaving the terminal :)
16+
17+
Demo
18+
^^^^
19+
20+
.. figure:: https://github.com/coderick14/ACedIt/blob/master/images/demo.gif
21+
:alt: Simple demo of how ACedIt works
22+
23+
Supported sites
24+
^^^^^^^^^^^^^^^
25+
26+
- Codeforces
27+
- Codechef
28+
- Spoj
29+
- Hackerrank
1730

1831
Installation
1932
^^^^^^^^^^^^
@@ -38,9 +51,9 @@ Usage
3851
::
3952

4053
usage: ACedIt [-h] [-s SITE] [-c CONTEST] [-p PROBLEM] [-f]
41-
[--run SOURCE_FILE]
42-
[--set-default-site {codeforces,codechef,hackerrank,spoj}]
43-
[--set-workdir WORKDIR]
54+
[--run SOURCE_FILE]
55+
[--set-default-site {codeforces,codechef,hackerrank,spoj}]
56+
[--set-workdir WORKDIR]
4457

4558
optional arguments:
4659
-h, --help show this help message and exit
@@ -59,9 +72,13 @@ Usage
5972
--set-workdir WORKDIR
6073
ABSOLUTE PATH to working directory
6174

62-
During installation, the default site is set to ``codeforces`` and the default working directory is set to ``/home/your-username/ACedIt``. You can change them anytime using the above mentioned flags.
75+
During installation, the default site is set to ``codeforces`` and the
76+
default working directory is set to ``/home/your-username/ACedIt``. You
77+
can change them anytime using the above mentioned flags.
6378

64-
ACedIt requires the following working directory structure.
79+
ACedIt requires the following working directory structure
80+
**(Recommended)**. It also has the added advantage of keeping your work
81+
organized :)
6582

6683
::
6784

@@ -79,23 +96,14 @@ ACedIt requires the following working directory structure.
7996
| |- Site2
8097
| | |- Contest1
8198
| | | |- Problem1
82-
8399

84-
| During installation, ACedIt will set up the basic working directory
85-
structure.
86-
| While prefetching test cases, it will modify the same accordingly
87-
without any user intervention.
88-
| But in case you’re writing your code first and then using
89-
``ACedIt --run <source_file>``, make sure you follow the directory
90-
structure mentioned.
100+
| During installation, ACedIt will set up the basic working directory structure.
101+
| While prefetching test cases, it will modify the same accordingly without any user intervention.
91102
92-
Supported sites
93-
^^^^^^^^^^^^^^^
103+
But in case you’re writing your code in some other directory, you can use ``ACedIt --run <SOURCE_FILE> -s SITE -c CONTEST -p PROBLEM``. You can omit ``-s`` as it’ll take the default site.
104+
105+
But there’s no need to specify the ``-s``, ``-c`` and ``-p`` flags if you follow the above mentioned directory structure (ACedIt will create most of it for you on the fly :)
94106

95-
- Codeforces
96-
- Codechef
97-
- Spoj
98-
- Hackerrank
99107

100108
Examples
101109
^^^^^^^^
@@ -118,7 +126,7 @@ Examples
118126

119127
ACedIt -s codeforces -c 86 -p D -f
120128

121-
- Test your code against sample cases
129+
- Test your code against sample cases (when following the recommended directory structure)
122130

123131
::
124132

@@ -128,20 +136,20 @@ Examples
128136

129137
ACedIt --run CHEFFA.py
130138

139+
- Test your code against sample cases (from any other directory)
131140

132-
Demo
133-
^^^^
141+
::
134142

135-
.. figure:: https://github.com/coderick14/ACedIt/blob/master/images/demo.gif
136-
:alt: Simple demo of how ACedIt works
143+
ACedIt --run solve.cpp -c 835 -p D
144+
145+
::
137146

147+
ACedIt --run test.py -s codechef -c AUG17 -p CHEFFA
138148

139149
Note :
140150
''''''
141151

142-
There might be some issues with Spoj, as they have widely varying DOM
143-
trees for different problems. Feel free to contribute on this. Or
144-
anything else that you can come up with :)
152+
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 :)
145153

146154
.. |contributions welcome| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
147155
:target: https://github.com/coderick14/ACedIt/issues

0 commit comments

Comments
 (0)