Skip to content
This repository was archived by the owner on Jun 3, 2025. It is now read-only.

Commit 57f05e9

Browse files
authored
Fix the header syntax
1 parent 8b301c4 commit 57f05e9

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@
77

88
![tmc-cli logo](https://rawgit.com/testmycode/tmc-cli/master/docs/logo_plain.svg)
99

10-
#tmc-cli
10+
# tmc-cli
1111

1212
TMC-CLI is the command-line client for University of Helsinki's TestMyCode -framework. TestMyCode is used by various online programming courses for exercise testing and submission.
1313

1414
![Demonstration](docs/demo.gif)
1515

16-
##Requirements
16+
## Requirements
1717

1818
* Java Runtime Environment 7
1919
* Linux, Mac OS X or Microsoft Windows
2020
* Currently only limited support for Windows
2121
* Other Unix-like systems may work, but are not tested
2222
* If you want autocompletion, Bash or a Bash-compatible shell is required
2323

24-
##Installation
24+
## Installation
2525

26-
###Using the install script (Linux/OS X only)
26+
### Using the install script (Linux/OS X only)
2727

2828
`cd` into the directory where you wish to install TMC-CLI. Then, copy and paste the following command in your terminal:
2929

@@ -33,7 +33,7 @@ curl -0 https://raw.githubusercontent.com/testmycode/tmc-cli/master/scripts/inst
3333

3434
TMC-CLI should now be installed. You can try running it with `tmc` in a new terminal.
3535

36-
###Manual installation
36+
### Manual installation
3737

3838
Download the latest [release](https://github.com/testmycode/tmc-cli/releases/latest). If you use Linux or OS X, choose "tmc". If you use Windows, choose "tmc-cli-[VERSION].jar".
3939

@@ -58,11 +58,11 @@ Tip: On Windows, use `doskey tmc="java -jar [path_to_tmc-cli.jar] $*"` in cmd.ex
5858

5959
Now that you've installed tmc-cli, you can view all available commands by running tmc without arguments or with `tmc --help`. You can also view all available options for commands by running them with the `--help` switch, for example `tmc courses --help`.
6060

61-
##Uninstallation
61+
## Uninstallation
6262

6363
Delete tmc from the directory where you downloaded it, .tmc-autocomplete.sh from your home directory and remove 'source $HOME/.tmc-autocomplete' from your shell rc file.
6464

65-
##Manual
65+
## Manual
6666

6767
The Unix man page for tmc-cli is located in docs/tmc.1 in this repository. To view it, open it with `man -l tmc.1`.
6868

@@ -72,7 +72,7 @@ For system administrators/packagers: To make the man page available for all user
7272

7373
You can also open the manual in your shell remotely with `curl -0s https://raw.githubusercontent.com/testmycode/tmc-cli/master/docs/tmc.1 | man -l -`. This will show the manual for the latest version. You may want to bind it to an alias for ease of use.
7474

75-
##Logging in
75+
## Logging in
7676

7777
Once installation is complete, you can log in using `tmc login`. This saves your TMC login information to a configuration file in ~/.config/tmc-cli/ (or %APPDATA% on Windows) - you will only have to log in once.
7878

@@ -84,7 +84,7 @@ password:
8484
Login successful.
8585
```
8686

87-
##Listing courses
87+
## Listing courses
8888

8989
Once you have logged in, you can list all the available courses on the server with `tmc courses`.
9090
```
@@ -98,7 +98,7 @@ javascript-for-lazy-hipsters
9898

9999
Note that you can only submit exercises on courses for which you have enrolled.
100100

101-
##Downloading courses
101+
## Downloading courses
102102

103103
Navigate to a suitable directory in which you wish to download your course(s). Then, run `tmc download [COURSE_NAME]`. This will create a new directory for your course and download all available exercises into it. By default, only exercises that you have not fully completed are downloaded - download all exercises with `-a`.
104104

@@ -114,7 +114,7 @@ exercise1/ exercise2/ exercise3/ exercise4/ .tmc.json
114114

115115
Course-specific information is stored in .tmc.json. Do not manually edit or remove it unless you are completely done with the course - doing so will cause tmc to not function properly.
116116

117-
##Running tests
117+
## Running tests
118118

119119
After you've completed an exercise and wish to run tests on it, navigate to the exercise directory and run `tmc test`. If you are in the course root directory, you can also give the names of the exercises as arguments: `tmc test exercise1 exercise2`. Running `tmc test` in the course root with no arguments will run tests on all exercises.
120120

@@ -125,7 +125,7 @@ Test results: 1/1 tests passed
125125
All tests passed! Submit to server with 'tmc submit'
126126
```
127127

128-
##Submitting exercises
128+
## Submitting exercises
129129

130130
You have now completed your first exercise! To submit your exercise, run `tmc submit`. The syntax is the same as for running tests.
131131

@@ -138,7 +138,7 @@ Points permanently awarded: [exercise1]
138138
Model solution: https://link.to.model/solution
139139
```
140140

141-
##Updating the course
141+
## Updating the course
142142

143143
As you complete exercises, more exercises may become available. To update the course and download new exercises, run `tmc update`.
144144

@@ -147,7 +147,7 @@ As you complete exercises, more exercises may become available. To update the co
147147
New exercises downloaded: [exercise5, exercise6]
148148
```
149149

150-
##Listing exercises
150+
## Listing exercises
151151

152152
If you want to see your current progress, you can view the status of all course exercises with `tmc exercises [course]`. By default, the exercise list is viewed in your system's pager, but you can print them directly to your terminal with the `-n` or `--no-pager` switch.
153153

@@ -161,7 +161,7 @@ Deadline: 2038-20-01 at 18:00:00
161161
Not completed: exercise4
162162
```
163163

164-
##Sending exercises to pastebin
164+
## Sending exercises to pastebin
165165

166166
If you're having trouble with an exercise or just want to have your code peer-reviewed, you can use `tmc paste` to send an exercise to the TMC server's pastebin. You'll be prompted to add a message, but it is optional.
167167

@@ -186,7 +186,7 @@ You cannot submit exercises that you have completed.
186186
## Crafting a release
187187
Releases are automatically built in Travis and pushed to GitHub releases. Once ready to release, update version in pom.xml and gat the commit accordingly. Once tests have passed a new release is uploaded to travis. Note: only travis runs with tag set are used for releases.
188188

189-
##Disclaimer
189+
## Disclaimer
190190

191191
This software is licensed under [the MIT license](https://raw.githubusercontent.com/testmycode/tmc-cli/instructions/LICENSE).
192192

0 commit comments

Comments
 (0)