Skip to content

Commit 7246c40

Browse files
committed
docs(help): add introduction
1 parent b42c06c commit 7246c40

3 files changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@ hi CompetiTestWrong ctermfg=red guifg=#ff0000
631631
- [x] Customizable folder structure for downloaded problems and contests
632632
- [x] Templates for files created when receiving problems or contests
633633
- [ ] Integration with tools to submit solutions ([api-client](https://github.com/online-judge-tools/api-client) or [cpbooster](https://github.com/searleser97/cpbooster))
634-
- [ ] Write Vim docs
634+
- [x] Write Vim docs
635635
- [x] Customizable highlights
636636
- [x] Resizable UI
637637

doc/competitest.nvim

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
================================================================================
2+
INTRODUCTION *competitest.nvim*
3+
4+
CompetiTest.nvim is a testcase manager and checker. It saves you time
5+
in competitive programming contests by automating common tasks related
6+
to testcase management.
7+
8+
Features:
9+
- Manage testcases:
10+
- add / edit / delete testcases
11+
- Compile and run solutions
12+
- Compare program output with expected answers
13+
14+
Additional:
15+
- Interactive UI to inspect results and outputs
16+
- Competitive Companion integration:
17+
- download problems, contests and testcases
18+
- Flexible configuration:
19+
- customizable compile and run commands
20+
- customizable UI layout
21+
- customizable testcase storage
22+
23+
More information: https://github.com/xeluxee/competitest.nvim
24+
25+
vim:tw=78:ts=8:ft=help:norl:

doc/tags

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
competitest.nvim competitest.txt /*competitest.nvim*

0 commit comments

Comments
 (0)