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

Commit e7944f1

Browse files
author
jclc
committed
updated docs
1 parent 861b53f commit e7944f1

3 files changed

Lines changed: 16 additions & 9 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ If for some reason the alias was not added to your .bashrc or your shell of choi
4242

4343
If you are using Windows and you downloaded the .jar file, you must use tmc-cli directly with Java like so: `java -jar [path_to_tmc-cli.jar]`. In the following examples, replace `tmc` with this command. (note: you must have set Java on your system `%PATH%`. For more information, see [this Java help page](https://www.java.com/en/download/help/path.xml).)
4444

45-
Tip: On Windows, use `doskey tmc="java - jar [path_to_tmc-cli.jar] $@"` to create a convenient alias.
45+
Tip: On Windows, use `doskey tmc="java -jar [path_to_tmc-cli.jar] $*"` in cmd.exe or `doskey /exename=powershell.exe tmc="java -jar [path_to_tmc-cli.jar] $*"` in PowerShell to create a convenient alias.
4646

4747
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`.
4848

docs/HACKING.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Architecture and Hacking the tmc-cli
22
====================================
33

44
## Requirements for developing tmc-cli
5-
* jdk 7
6-
* linux bash (mac's bash won't work)
5+
* JDK 7
6+
* Modern Linux Bash (Mac's Bash won't work)
77

88

99
## Building tmc-cli
@@ -21,9 +21,9 @@ Conceptually, there are three main parts in the program; the launch code, backen
2121
and the commands. The commands are gathered into their own package. In addition, there are utility
2222
classes in order to take care of user input/output and file handling.
2323

24-
The tmc-cli itself is mostly just an command line interface for the backend libraries.
24+
Tmc-cli itself is mostly just an command line interface for the backend libraries.
2525
All the heavy lifting is done by [tmc-core](https://github.com/testmycode/tmc-core) and
26-
[tmc-langs](https://github.com/testmycode/tmc-langs) libraries. The tmc-cli also requires the
26+
[tmc-langs](https://github.com/testmycode/tmc-langs) libraries. Tmc-cli also requires the
2727
server-side component of TestMyCode aka. [tmc-server](https://github.com/testmycode/tmc-server).
2828

2929
### Important classes
@@ -115,3 +115,11 @@ public class ExampleCommandTest {
115115

116116
If you are doing tests for any other class, simply create normal unit tests
117117
that don't depend on any command.
118+
119+
##Updating the documentation
120+
121+
Please document any new features or revisions in MANUAL.md and HISTORY.md as well
122+
as README.md, if the affected feature is already documented there.
123+
124+
If you make changes to MANUAL.md, please rebuild tmc.1 before you push your changes.
125+
Use `[md2man](https://github.com/sunaku/md2man)-roff docs/MANUAL.md > docs/tmc.1` to build the manpage.

docs/MANUAL.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
TMC-CLI 1 2016-06-30 "Helsinki Univ. Dep. of CS" "TMC-CLI Manual"
2-
=================================================================
1+
TMC-CLI 1 2016-06-30 "TestMyCode" "TMC-CLI Manual"
2+
==================================================
33

44
NAME
55
----
@@ -207,8 +207,7 @@ FILES
207207
`[course directory]/.tmc.json`
208208
Course configuration and cache file. Saves the status of the username, server
209209
address and course's exercises. Manually editing this file may have adverse
210-
effects.
211-
210+
effects.
212211

213212
`~/.config/tmc-cli/properties.json`
214213
User configuration file. Use `tmc prop` to edit properties.

0 commit comments

Comments
 (0)