Merge pull request #28 from barrett-ruth/fix/doc

fix: update docs, no more vim.g
This commit is contained in:
Barrett Ruth 2025-09-14 08:53:59 +02:00 committed by GitHub
commit 10a9ff1e4c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 21 additions and 39 deletions

1
.gitignore vendored
View file

@ -1,3 +1,4 @@
.venv/ .venv/
doc/tags
venv/ venv/
CLAUDE.md CLAUDE.md

View file

@ -66,9 +66,8 @@ CONFIGURATION *cp-config*
cp.nvim works out of the box. No setup required. cp.nvim works out of the box. No setup required.
Optional: > Optional configuration: >
vim.g.cp = { require('cp').setup({
config = {
debug = false, debug = false,
contests = { contests = {
default = { default = {
@ -81,15 +80,13 @@ Optional: >
}, },
hooks = { hooks = {
before_run = function(problem_id) vim.cmd.w() end, before_run = function(problem_id) vim.cmd.w() end,
before_debug = function(problem_id) ... end,
}, },
tile = function(source_buf, input_buf, output_buf) tile = function(source_buf, input_buf, output_buf)
-- custom window layout
end, end,
filename = function(contest, problem_id, problem_letter) filename = function(contest, problem_id, problem_letter)
-- custom filename generation
end, end,
} })
}
< <
Configuration options: Configuration options:

View file

@ -1,16 +0,0 @@
:CP cp.txt /*:CP*
cp cp.txt /*cp*
cp-atcoder cp.txt /*cp-atcoder*
cp-codeforces cp.txt /*cp-codeforces*
cp-commands cp.txt /*cp-commands*
cp-config cp.txt /*cp-config*
cp-cses cp.txt /*cp-cses*
cp-example cp.txt /*cp-example*
cp-files cp.txt /*cp-files*
cp-health cp.txt /*cp-health*
cp-platforms cp.txt /*cp-platforms*
cp-requirements cp.txt /*cp-requirements*
cp-snippets cp.txt /*cp-snippets*
cp-workflow cp.txt /*cp-workflow*
cp.nvim cp.txt /*cp.nvim*
cp.txt cp.txt /*cp.txt*