Skip to content

Commit ed3ad48

Browse files
[Docs]: Added screenshots as part of the instructions (#68)
* docs: add screenshots to guide/readme * docs: updated the screenshots * docs: increase space between paragraphs * fix: minor tweak Co-authored-by: James George <[email protected]>
1 parent ae7a49d commit ed3ad48

File tree

1 file changed

+47
-4
lines changed

1 file changed

+47
-4
lines changed

docs/guide/README.md

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,57 @@
77
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.
88

99
- `teachcode` expects you to have a GitHub account. Make sure that you create one if that's not the case.
10-
- Navigate to the directory of your choice and type in `teachcode init`.
11-
- Follow the instructions as prompted.
12-
- Now type in `cd teachcode-solutions`.
10+
- Navigate to the directory of your choice and type in `teachcode init`. After typing the command, the following window would appear in your terminal
11+
12+
<br />
13+
14+
![image](https://user-images.githubusercontent.com/59525675/71776957-9b5c5500-2fbf-11ea-93fa-830f0842ac72.png)
15+
16+
<br />
17+
18+
- Select the language of your choice and follow the instructions as prompted.
19+
20+
<br />
21+
22+
![image](https://user-images.githubusercontent.com/43414928/71539868-c82dbe00-2968-11ea-997d-bb1e8ca01295.png)
23+
24+
<br />
25+
26+
- After entering your Github user token, you would get the following screen. Now type in `cd teachcode-solutions`.
1327
- 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)
32+
33+
<br />
34+
1435
- Hurray :tada: , you've got your first task.
1536
- Now you can find a `config.json` and `task1.py` (language of choice) file within the `teachcode-solutions` directory.
37+
38+
<br />
39+
40+
![image](https://user-images.githubusercontent.com/59525675/71777696-458caa80-2fc9-11ea-9b07-89e6fc9f9432.png)
41+
42+
<br />
43+
1644
- Open up your favorite editor and code up the solution.
45+
46+
<br />
47+
48+
![image](https://user-images.githubusercontent.com/59525675/71777665-065e5980-2fc9-11ea-80d8-a4b34ad8657d.png)
49+
50+
<br />
51+
1752
- Now type in `teachcode submit`.
1853
- Enter your Git credentials when prompted.
1954
- If the current solution satisfies all test cases, you'll get the key to proceed farther.
20-
- Grab the key and type in `teachcode fetchtask <key>`.
55+
- Grab the key and type in `teachcode fetchtask <key>`.
56+
- Solve all 30 question, to complete the task
57+
58+
59+
*In case you forget your key, just type in `teachcode showkeys` to see the list of all keys*
60+
- That's all folks, good luck :+1:
61+
62+
63+

0 commit comments

Comments
 (0)