Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
confestim committed Nov 18, 2024
1 parent 76eeafc commit 4404da7
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,28 @@ temmies init {year}/{course}/{assignment} {path}
```
> `temmies init 2024-2025/advalgo/labs-wk2 .`
### Initializing an entire course
```bash
temmies init {year}/{course}
```
### Optional args
- `-s` : Search for an assignment instead of providing the link i.e. `temmies init -s "Advanced Algorithms" `.
- `-t <path>`: Specify where you want your tests to be (relative to the parent of each assignment folder). Default is `.`.

### File hierarchy example
Once the command is run.
Once the command is ran:
```
.
├── practical_1
│ │ .temmies <-- This file holds all relevant information
│ ├── pizza
| | | .temmies <-- This is the temmies file which lets you do `temmies submit`
│ │ ├── tcs
│ │ │ ├── 1.in
│ │ │ ├── 1.out
│ │ │ ├── 6.in
│ │ │ ├── 6.out
│ └── tunnel
| | | .temmies <-- there's one of these in each assignment folder
│ │ ├── tcs
│ │ │ ├── 1.in
│ │ │ ├── 1.out
Expand All @@ -54,5 +60,5 @@ Submits a file to the relevant assignment. You can pass multiple files as well.
Shows an overview of the current assignment's status.

### Optional args
- `-d` : Adds some more detail
- `-d` : Adds some more detail (i.e. the leading submission)

0 comments on commit 4404da7

Please # to comment.