Skip to content

Commit df10b79

Browse files
docs: update info
1 parent d9e549d commit df10b79

File tree

3 files changed

+7
-13
lines changed

3 files changed

+7
-13
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Users are required to solve 30 tasks that take them through the basic constructs
5252
| teachcode init | Initializes all the tasks |
5353
| teachcode fetchtask [key] | Fetches the task correponding to the key if provided (defaults to the very next task) |
5454
| teachcode submit | Submits the current task |
55-
| teachcode showkeys | Shows all the keys grabbed |
55+
| teachcode showkeys | Lists all the keys associated with the submitted tasks |
5656

5757
## Contributing
5858

docs/guide/README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
## How it works
66

7-
Users are required to solve 30 tasks that take them through the basic constructs of the programming language of their choice. The tasks are designed in such a way that the complexity increases as users progress through the tasks. Users can't move forward until the current task is completed (since the progress is determined by a unique key that is generated upon successful completion). Previously submitted tasks can be viewed as desired by the user but can't be worked on again.
7+
Users are required to solve 30 tasks that take them through the basic constructs of the programming language of their choice. The tasks are designed in such a way that the complexity increases as users progress through the tasks. Users can't move forward until the current task is completed. Previously submitted tasks can be viewed as desired by the user but can't be worked on again.
88

99
- `teachcode` expects you to have a GitHub account. Make sure that you create one if that's not the case.
1010
- Navigate to the directory of your choice and type in `teachcode init`. After typing the command, the following window would appear in your terminal
@@ -23,12 +23,7 @@ Users are required to solve 30 tasks that take them through the basic constructs
2323

2424
<br />
2525

26-
- After entering your Github user token, you would get the following screen. Now type in `cd teachcode-solutions`.
27-
- Grab the initial key and type in `teachcode fetchtask <key>`.
28-
29-
<br />
30-
31-
![image](https://user-images.githubusercontent.com/59525675/71777005-669ccd80-2fc0-11ea-8cc3-ea1c729c18da.png)
26+
- After entering your Github user token, you would get the following screen. Now type in `cd teachcode-solutions` followed by `teachcode fetchtask`.
3227

3328
<br />
3429

@@ -52,11 +47,11 @@ Users are required to solve 30 tasks that take them through the basic constructs
5247
- Now type in `teachcode submit`.
5348
- Enter your Git credentials when prompted.
5449
- If the current solution satisfies all test cases, you'll get the key to proceed farther.
55-
- Grab the key and type in `teachcode fetchtask <key>`.
50+
- Now type in `teachcode fetchtask`.
5651
- Solve all 30 question, to complete the task
5752

5853

59-
*In case you forget your key, just type in `teachcode showkeys` to see the list of all keys*
54+
*In case you want to revisit any of the previously submitted tasks, grab the associated key by typing in `teachcode showkeys` followed by `teachcode fetchtask <key>`*
6055
- That's all folks, good luck :+1:
6156

6257

docs/guide/commands.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,9 @@ title: 'Available Commands'
99
| command | description |
1010
| -------------- | ---------------- |
1111
| teachcode init | Initializes all the tasks |
12-
| teachcode fetchtask \<key\> | Fetches the task correponding to key provided |
12+
| teachcode fetchtask \[key\] | Fetches the task correponding to the key if provided (Defaults to the very next task) |
1313
| teachcode submit | Submits the current task |
14-
| teachcode showkeys | Shows all the keys grabbed |
15-
| teachcode showcommands | Lists all the available commands |
14+
| teachcode showkeys | Lists all the keys associated with the submitted tasks |
1615

1716
## Versioning And Help
1817

0 commit comments

Comments
 (0)