search

Benezivas / algobattle

Let teams compete by making them create hard instances and fast solvers for problems of your choice. Then pitch these instances and solvers against one another. All language-agnostic.
https://algobattle.org
MIT License
8 stars 3 forks source link

Docs problem creation #160

Closed Benezivas closed 9 months ago

Benezivas commented 9 months ago

This PR adds documentation for creating problems. It discusses the basic interaction between the algobattle framework and problem files and walks the reader through the creation of a concrete, new problem.

Still missing and only added as a stub in this PR is the discussion on using alternative I/O formats other than JSON. I am not familiar enough with the framework to have the authority to discuss this topic, but deem it important that this should be discussed in this context. Please do not merge this PR until this is resolved.

ImogenBits commented 9 months ago

I added some more things and reshuffled the file structure a bit. This now includes details on custom I/O formatting, using type annotations, and some other advanced features.

Note that this PR now is dependent on #161.

Benezivas commented 9 months ago

Thank you very much for these additional changes and many additions, this goes well beyond what I set out to document. I like the restructuring that you did, the separation between student and instructor material, as well as additional content, is now much clearer. From my point of view this branch is ready to merge. I would also vote for creating a new minor release afterwards.

ImogenBits commented 9 months ago

yeah that looks good. I've made another PR, #162, that I'd also include in the new release.