Skip to content

Commit 9142a6f

Browse files
committed
Update README
1 parent d85f87a commit 9142a6f

File tree

2 files changed

+34
-77
lines changed

2 files changed

+34
-77
lines changed

README.md

Lines changed: 16 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,15 @@ pip install --user ACedIt
2828

2929
#### Usage
3030
```
31-
usage: acedit [-h] [-s SITE] [-c CONTEST] [-p PROBLEM] [-f]
32-
[--run SOURCE_FILE]
31+
usage: acedit [-h] [-s {codeforces,codechef,hackerrank,spoj}] [-c CONTEST]
32+
[-p PROBLEM] [-f] [--run SOURCE_FILE]
3333
[--set-default-site {codeforces,codechef,hackerrank,spoj}]
34-
[--set-workdir WORKDIR]
34+
[--set-default-contest DEFAULT_CONTEST]
3535
3636
optional arguments:
3737
-h, --help show this help message and exit
38-
-s SITE, --site SITE The competitive programming platform, e.g. codeforces,
38+
-s {codeforces,codechef,hackerrank,spoj}, --site {codeforces,codechef,hackerrank,spoj}
39+
The competitive programming platform, e.g. codeforces,
3940
codechef etc
4041
-c CONTEST, --contest CONTEST
4142
The name of the contest, e.g. JUNE17, LTIME49, COOK83
@@ -47,36 +48,12 @@ optional arguments:
4748
--set-default-site {codeforces,codechef,hackerrank,spoj}
4849
Name of default site to be used when -s flag is not
4950
specified
50-
--set-workdir WORKDIR
51-
ABSOLUTE PATH to working directory
52-
53-
```
54-
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.
55-
56-
ACedIt requires the following working directory structure **(Recommended)**. It also has the added advantage of keeping your work organized :)
57-
```
58-
workdir
59-
|
60-
|-ACedIt
61-
| |
62-
| |- Site1
63-
| | |- Contest1
64-
| | | |- Problem1
65-
| | | |- Problem2
66-
| | |- Contest2
67-
| | | |- Problem1
68-
| | | |- Problem2
69-
| |- Site2
70-
| | |- Contest1
71-
| | | |- Problem1
51+
--set-default-contest DEFAULT_CONTEST
52+
Name of default contest to be used when -c flag is not
53+
specified
7254
7355
```
74-
During installation, ACedIt will set up the basic working directory structure.
75-
While prefetching test cases, it will modify the same accordingly without any user intervention.
76-
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 :)***
56+
During installation, the default site is set to `codeforces`. You can change it anytime using the above mentioned flags.
8057

8158
#### Examples
8259
+ Fetch test cases for a single problem
@@ -91,20 +68,23 @@ acedit -s codechef -c AUG17
9168
```
9269
acedit -s codeforces -c 86 -p D -f
9370
```
94-
+ Test your code against sample cases (when following the recommended directory structure)
71+
+ Test your code (when default-site and default-contest is set and filename is same as problem_code)
9572
```
9673
acedit --run D.cpp
9774
```
9875
```
9976
acedit --run CHEFFA.py
10077
```
101-
+ Test your code against sample cases (from any other directory)
78+
**Since your filename is same as problem code, there's no need for the `-p` flag.**
79+
+ Test your code (specifying contest and problem codes explicitly)
10280
```
10381
acedit --run solve.cpp -c 835 -p D
10482
```
10583
```
10684
acedit --run test.py -s codechef -c AUG17 -p CHEFFA
10785
```
10886

109-
##### Note :
110-
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 :)
87+
##### Note :
88+
+ The working directory structure mentioned in the previous versions is no longer required and supported.
89+
90+
+ 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: 18 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,15 @@ Usage
5050

5151
::
5252

53-
usage: acedit [-h] [-s SITE] [-c CONTEST] [-p PROBLEM] [-f]
54-
[--run SOURCE_FILE]
55-
[--set-default-site {codeforces,codechef,hackerrank,spoj}]
56-
[--set-workdir WORKDIR]
53+
usage: acedit [-h] [-s {codeforces,codechef,hackerrank,spoj}] [-c CONTEST]
54+
[-p PROBLEM] [-f] [--run SOURCE_FILE]
55+
[--set-default-site {codeforces,codechef,hackerrank,spoj}]
56+
[--set-default-contest DEFAULT_CONTEST]
5757

5858
optional arguments:
5959
-h, --help show this help message and exit
60-
-s SITE, --site SITE The competitive programming platform, e.g. codeforces,
60+
-s {codeforces,codechef,hackerrank,spoj}, --site {codeforces,codechef,hackerrank,spoj}
61+
The competitive programming platform, e.g. codeforces,
6162
codechef etc
6263
-c CONTEST, --contest CONTEST
6364
The name of the contest, e.g. JUNE17, LTIME49, COOK83
@@ -69,40 +70,12 @@ Usage
6970
--set-default-site {codeforces,codechef,hackerrank,spoj}
7071
Name of default site to be used when -s flag is not
7172
specified
72-
--set-workdir WORKDIR
73-
ABSOLUTE PATH to working directory
74-
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.
78-
79-
ACedIt requires the following working directory structure
80-
**(Recommended)**. It also has the added advantage of keeping your work
81-
organized :)
82-
83-
::
84-
85-
workdir
86-
|
87-
|-ACedIt
88-
| |
89-
| |- Site1
90-
| | |- Contest1
91-
| | | |- Problem1
92-
| | | |- Problem2
93-
| | |- Contest2
94-
| | | |- Problem1
95-
| | | |- Problem2
96-
| |- Site2
97-
| | |- Contest1
98-
| | | |- Problem1
99-
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.
102-
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.
73+
--set-default-contest DEFAULT_CONTEST
74+
Name of default contest to be used when -c flag is not
75+
specified
10476

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 :)
77+
During installation, the default site is set to ``codeforces``. You
78+
can change it anytime using the above mentioned flags.
10679

10780

10881
Examples
@@ -126,7 +99,7 @@ Examples
12699

127100
acedit -s codeforces -c 86 -p D -f
128101

129-
- Test your code against sample cases (when following the recommended directory structure)
102+
- Test your code (when default-site and default-contest is set and filename is same as problem_code)
130103

131104
::
132105

@@ -136,7 +109,9 @@ Examples
136109

137110
acedit --run CHEFFA.py
138111

139-
- Test your code against sample cases (from any other directory)
112+
**Since your filename is same as problem code, there's no need for the -p flag.**
113+
114+
- Test your code (specifying contest and problem codes explicitly)
140115

141116
::
142117

@@ -149,7 +124,9 @@ Examples
149124
Note :
150125
''''''
151126

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 :)
127+
- The working directory structure mentioned in the previous versions is no longer required and supported.
128+
129+
- 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 :)
153130

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

0 commit comments

Comments
 (0)