@@ -5,7 +5,23 @@ A helpful command-line interface for AUCPL problem setters.
55> [ !WARNING]
66> This tool is currently in active development, and breaking changes can occur at any point.
77
8- ## Getting started
8+ ## Features
9+
10+ - Automatically generate test case outputs when provided input files and reference solutions
11+ - Run batch test cases on problems
12+ - Easily switch between languages when testing solutions
13+ - Check/validate problems to ensure things are correct (e.g. no missing test cases)
14+ - Easy management and organisation of problems and competitions with options to create, rename, archive, and more
15+
16+ Planned:
17+
18+ - Automatic formatting of problems and solution files
19+ - Uploading problems and test cases to an online judge
20+ - Testing code within judge environments
21+ - Improve checking/validation of problems, covering more criteria
22+ - Shell auto completions
23+
24+ ## Install
925
1026Make sure you have Rust installed. Build the binary:
1127
@@ -48,3 +64,31 @@ problems/
4864
4965- ** Problem name** : The name that's used to reference the problem in the CLI
5066- ** Problem title** : The title of the problem to put in the problem statement
67+
68+ ### Commands
69+
70+ Here are a list of some of the commands.
71+
72+ Problems
73+
74+ - ` aucpl problem create ` : Create a new problem and generate necessary files
75+ - ` aucpl problem solve ` : Automatically generate output test cases for a given problem
76+ - ` aucpl problem test ` : Automatically run all tests for a given problem
77+ - ` aucpl problem check ` : Ensure test cases and files are not missing
78+ - ` aucpl problem archive ` : Archive a problem
79+
80+ Competitions
81+
82+ - ` aucpl comp create ` : Create a new competition
83+ - ` aucpl comp add ` : Add a problem to the competition
84+ - ` aucpl comp finish ` : Mark a competition as completed and archive all problems under the competition
85+ - ` aucpl comp list ` : List all competitions or problems in a competition
86+ - ` aucpl comp solve ` : Generate output test cases for all problems in a given competition
87+ - ` aucpl comp test ` : Run tests for all problems in a given competition
88+ - ` aucpl comp remove ` : Remove a problem from the competition
89+ - ` aucpl comp rename ` : Rename a competition
90+
91+ Other
92+
93+ - ` aucpl help ` : Show help
94+ - ` aucpl sync ` : Generate or update the problem mappings file
0 commit comments