You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 3, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,9 +81,14 @@ Once installation is complete, you can log in using `tmc login`. This saves your
81
81
server address:
82
82
username:
83
83
password:
84
-
Login successful.
84
+
Choose organization by writing its slug:
85
+
Do you want to send crash reports for client development? (Y/n)
86
+
Do you want to send analytics data for research? (Y/n)
85
87
```
86
88
89
+
You can change your organization with the command `organization`. Use the option `-o` and give the slug of an organization as an argument. Otherwise all available organizations will be listed.
90
+
You can inspect and change your settings such as sending data with the command `config`. Use the option `-l` to see your current settings and give `[KEY]=[NEW VALUE]` as arguments to change them.
91
+
87
92
## Listing courses
88
93
89
94
Once you have logged in, you can list all the available courses on the server with `tmc courses`.
@@ -96,7 +101,7 @@ c-mooc
96
101
javascript-for-lazy-hipsters
97
102
```
98
103
99
-
Note that you can only submit exercises on courses for which you have enrolled.
104
+
Note that you can only exercises on courses for which you have enrolled.
100
105
101
106
## Downloading courses
102
107
@@ -127,7 +132,7 @@ All tests passed! Submit to server with 'tmc submit'
127
132
128
133
## Submitting exercises
129
134
130
-
You have now completed your first exercise! To submit your exercise, run `tmc submit`. The syntax is the same as for running tests.
135
+
You have now completed your first exercise! To submit your exercise, run `tmc submit [exercise-name]` or run `tmc submit` in an exercise directory. The syntax is the same as for running tests.
Copy file name to clipboardExpand all lines: docs/HACKING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,14 +105,14 @@ public class ExampleCommandTest {
105
105
106
106
If you are doing tests for any other class, simply create normal unit tests that don't depend on any command.
107
107
108
-
##Adding properties
108
+
##Adding properties
109
109
110
110
Properties are saved as a Java `HashMap<String, String>`. They are read from ~/.config/tmc-cli/properties.json on initialisation. The purpose of the properties file is to provide a backwards- and forwards-compatible method of storing user preferences and internal data. Properties can be accessed via the `CliContext` class method getProperties(). Remember to store any changes to the properties with saveProperties(). Feel free to create new properties, but please document *all* properties in the 'COMMAND: PROP'-section of MANUAL.md.
111
111
112
-
##Updating the documentation
112
+
##Updating the documentation
113
113
114
114
Please document any new features or revisions in MANUAL.md and HISTORY.md as well as README.md, if the affected feature is already documented there.
115
115
116
116
If you make changes to MANUAL.md, please rebuild tmc.1 with [md2man](https://github.com/sunaku/md2man) before you push your changes. Use `md2man-roff docs/MANUAL.md > docs/tmc.1` to build the manpage.
117
117
118
-
There are no strict guidelines for README.md or MANUAL.md, but please try not to deviate from the original style (eg. new command sections should follow the same pattern).
118
+
There are no strict guidelines for README.md or MANUAL.md, but please try not to deviate from the original style (eg. new command sections should follow the same pattern).
Change progress bar colours. Recognised values: black, red, green, yellow,
200
-
blue, purple, cyan, white, none.
204
+
blue, purple, cyan, white, none. Stored in properties.
205
+
**send-diagnostics*
206
+
Allow sending crash reports and analytics for client development. Stored with account.
207
+
**send-analytics*
208
+
Allow sending analytics data of commands run. Stored in account.
209
+
**server-address*
210
+
Address to fetch courses from and submit to. Defaults to `https://tmc.mooc.fi`. Stored with account. Changing the server address will log the user out and prompt a new login.
211
+
212
+
COMMAND: ORGANIZATION
213
+
---------------
214
+
215
+
`tmc``organization`[`-o`][*slug*] ...
216
+
217
+
Change organization, which determines the downloadable courses. If no slug is given, or the slug is invalid, all available organizations are listed, and the user will be prompted to choose one.
218
+
219
+
`-o``--organization`
220
+
Change organization to slug given as an argument without the listing of all organizations.
201
221
202
222
---
203
223
@@ -207,17 +227,17 @@ FILES
207
227
`[course directory]/.tmc.json`
208
228
Course configuration and cache file. Saves the status of the username, server
209
229
address and course's exercises. Manually editing this file may have adverse
210
-
effects.
230
+
effects.
211
231
212
232
`~/.config/tmc-cli/properties.json`
213
233
User configuration file. Use `tmc prop` to edit properties.
214
234
215
235
`~/.config/tmc-cli/accounts.json`
216
236
User login credentials. Use `tmc logout` to safely delete.
217
-
237
+
218
238
`~/.config/tmc-cli/logs/tmc-cli.log`
219
239
Debug logging.
220
-
240
+
221
241
For more on config locations, see `ENVIRONMENT` -> `XDG_CONFIG_HOME` and `APPDATA`.
222
242
223
243
ENVIRONMENT
@@ -230,10 +250,10 @@ ENVIRONMENT
230
250
`PAGER`
231
251
Pager for displaying text files. If unset, defaults to `less -R` on Unix.
232
252
This functionality is broken on Windows, but defaults to `more`.
233
-
253
+
234
254
`XDG_CONFIG_HOME`
235
255
If set on Unix, *~/.config/* in config file paths is replaced with its value.
236
-
256
+
237
257
`APPDATA`
238
258
On Windows, *~/.config/* is replaced with the value of `%APPDATA%`, usually
239
259
*C:\\Users\\Username\\AppData\\Roaming\\.* If `%APPDATA%` is unset, user's home
0 commit comments