Skip to content

Commit b1d1793

Browse files
committed
fix programs tutorial section on packaging programs
1 parent ed7abe8 commit b1d1793

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

docs/tutorial/programs.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -301,12 +301,23 @@ This time it should run without any errors. If that doesn't work for you, there'
301301
## Packaging the Programs
302302

303303
You may want to share your code with e.g. your lab instructors. The best way to do that is to package them into Algobattle
304-
program files. These are files using the `.prob` file extension that are formatted in such a way that Algobattle recognises
305-
them and can use them to run matches.
304+
program files. We do this by running
305+
306+
```
307+
algobattle package programs
308+
```
309+
310+
!!! note "Using the web framework"
311+
If your lab is using the web framework, these files are what you need to upload to have your programs run in the
312+
matches.
313+
314+
!!! tip "Keep program sizes down"
315+
Algobattle will package everything in the program directories. This may include unnecessary build artefacts, logs,
316+
program output, etc. It's best to remove any superfluous files (in particular, anything in your `.gitignore`)
317+
from the directories before running this command.
306318

307319
!!! tip "A peek behind the curtain"
308320
These files again are just `zip` files containing everything in your programs' folders in a specific format.
309-
It's best to remove any unnessesary files from them before packaging to keep file sizes down.
310321

311-
!!! note "Using the web framework"
312-
If your lab is using the web framework, these files are what you need to upload to have your programs run in the matches.
322+
This will create two `.prog` files that contain all the data Algobattle needs to run our programs. We can then easily
323+
share our code using just these files, or upload them to the Algobattle website.

0 commit comments

Comments
 (0)