mkcpr

所属分类:collect
开发工具:TeX
文件大小:0KB
下载次数:0
上传日期:2021-04-04 20:08:19
上 传 者sh-1993
说明:  竞争性编程参考生成器工具,
(Competitive Programming Reference Builder Tool,)

文件列表:
.vscode/ (0, 2021-04-04)
.vscode/.ropeproject/ (0, 2021-04-04)
.vscode/.ropeproject/config.py (4794, 2021-04-04)
.vscode/.ropeproject/objectdb (216, 2021-04-04)
.vscode/tasks.json (382, 2021-04-04)
CODE_OF_CONDUCT.md (3356, 2021-04-04)
Example/ (0, 2021-04-04)
Example/CodeFolder/ (0, 2021-04-04)
Example/CodeFolder/Extras/ (0, 2021-04-04)
Example/CodeFolder/Extras/Maths/ (0, 2021-04-04)
Example/CodeFolder/Extras/Maths/Common Sums.tex (1596, 2021-04-04)
Example/CodeFolder/Extras/Maths/Logarithm Rules.tex (524, 2021-04-04)
Example/CodeFolder/Graphs/ (0, 2021-04-04)
Example/CodeFolder/Graphs/Articulation Points And Bridges.cpp (1015, 2021-04-04)
Example/CodeFolder/Graphs/Data Structures/ (0, 2021-04-04)
Example/CodeFolder/Graphs/Data Structures/Union Find.cpp (638, 2021-04-04)
Example/CodeFolder/Graphs/Flow/ (0, 2021-04-04)
Example/CodeFolder/Graphs/Flow/.mkcpr_order (60, 2021-04-04)
Example/CodeFolder/Graphs/Flow/Max Flow Min Cut Dinic.cpp (1658, 2021-04-04)
Example/CodeFolder/Graphs/Flow/Max Flow Min Cut Edmonds-Karp.cpp (1260, 2021-04-04)
Example/CodeFolder/Graphs/Shortest Paths/ (0, 2021-04-04)
Example/CodeFolder/Graphs/Shortest Paths/Dijkstra.cpp (835, 2021-04-04)
Example/CodeFolder/Graphs/Topological Sort.cpp (622, 2021-04-04)
Example/Output.pdf (127783, 2021-04-04)
Example/Output.tex (14868, 2021-04-04)
Example/Template.tex (2074, 2021-04-04)
Example/mkcpr-config.json (404, 2021-04-04)
LICENSE (35132, 2021-04-04)
mkcpr/ (0, 2021-04-04)
mkcpr/Config.py (6550, 2021-04-04)
mkcpr/Error.py (2239, 2021-04-04)
mkcpr/Util.py (1999, 2021-04-04)
mkcpr/__init__.py (0, 2021-04-04)
mkcpr/__pycache__/ (0, 2021-04-04)
mkcpr/__pycache__/Error.cpython-37.pyc (1655, 2021-04-04)
mkcpr/main.py (5740, 2021-04-04)
pyproject.toml (636, 2021-04-04)

# mkcpr · [![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/searleser97/mkcpr/blob/master/LICENSE) [![PyPI version fury.io](https://badge.fury.io/py/mkcpr.svg)](https://pypi.org/project/mkcpr/) ### Competitive Programming Reference Builder Tool ## About ```mkcpr``` is a command line utility written in python that helps you to build your *Competitive Programming Reference* in PDF. This command will generate a LaTex formatted file, which will be ready to be compiled into your new *Competitive Programming Reference*, using any online or local LaTex compiler of your preference. ## Usage - In your working directory run: ```shell mkcpr [-c|-h] ``` **Notes:** - The configuration file ```mkcpr-config.json``` should be in the same working directory. (Same path where you run ```mkcpr```). - ```-c``` flag creates a new configuration file ```mkcpr-config.json``` in the current directory. - ```-h``` displays help. ## Requirements - python 3.5+ - Online or local LaTex compiler - Folder containing your codes for programming competitions - LaTex template (you can use the one provided in this repository ```Example/Template.tex```) - Configuration File ```mkcpr-config.json``` (described below) ## Installation 1. Run: ```shell pip install mkcpr --user ``` 2. Copy the LaTex template ```Template.tex``` located in the ```Example``` folder of this repository to your working directory. 3. In your working directory run ```mkcpr -c``` to create a new configuration file ```mkcpr-config.json```. 4. Update ```mkcpr-config.json``` and ```Template.tex``` according to your needs. See the [Configuration file options](#configuration-file-options) section for reference. 5. You are now ready to run ```mkcpr``` in your working directory. ## Configuration File Options ```jsonc { "code_folder": "/home/san/Projects/mkcpr/Example/CodeFolder", // Path to your actual code for reference "template_path": "/home/san/Projects/mkcpr/Example/Template.tex", // LaTex template path "output_file_path": "/home/san/Projects/mkcpr/Example/Output.tex", // path where you want the generated LaTex code to be "excluded": ["__pycache__", ".vscode"], // folders not to consider "columns": 2, // number of columns in your reference "template_placeholder": "CODE HERE", // text to replace in your template "sort_before": ["Data Structures"], // files or folders will appear first "sort_after": ["Extras"], // file or folders will appear at the end } ``` ## Features - One single command and your reference will be ready to compile - Build it with your own style - support for most file extensions. (.cpp, .py, .java, .tex, .sh, ...) - Build your reference just from your competitive programming code folder.
Folder Structure Table Of Contents
- Forget about undesired line breaks by specifying the lines of code you want together in the same page with a single comment before your lines of code.
## Override Default Ordering You can specify the order of files and folders by creating a file called `.mkcpr_order` in the directory where you want to override the default ordering (lexicographic). This file should contain the name of all the files and folders that are in the same directory sorted as you desire. Example: https://github.com/searleser97/Algorithms-In-A-White-Box/blob/master/Book/.mkcpr_order ## Example You can see an example of how a working directory would look like in a real *Competitive Progamming Reference* [HERE](https://github.com/searleser97/competitive-programming-reference) ## License ```mkcpr``` is licensed under the [GNU General Public License v3.0](https://github.com/searleser97/mkcpr/blob/master/LICENSE)

近期下载者

相关文件


收藏者