Skip to content

ToxicPie/NaCl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NaCl - NCTU_a Contest library

ICPC codebook of the team NCTU_a.

Building

Run make codebook to build the PDF. Run make help for a list of build commands.

Editing

Editing the codebook's content should be very simple, thanks to the automated TeX file generator.

To add new content to the codebook, first put the files to add (code snippets or TeX files) somewhere under nacl/. You may also modify existing files.

To change the files to include, section names, or arrangements, etc., edit codebook/config.yaml. It should have a structure like this:

include:
  - Section 1:
    - path_to_file
    - Subsection 1.1:
      - Subsubsection 1.1.1:
        - ...:
          - path_to_file
          - path_to_file
      - ...
    - ...
  - Section 2:
    - ...
  - ...
some_additional_configs:
  ...

Paths should be relative to nacl/. .tex files will be directly inputted, and other files will be shown as highlighted code. See the default config file for a complete example.

By default, all local dependencies for C/C++ files are shown. When there are #include "..." directives in a file, NaCl will show the section that the included file belongs to. It will also refuse to work if there is a dependency cycle. These behaviors can be changed in the config file.

#includes and comments of the form /// ... are removed, unless you add // keep-line to the end of a line.

Dependencies

  • A TeX distribution
  • Python 3.6 or newer
    • pyyaml package
    • pygments package
  • Clang-Format 13 or newer
  • Fira Mono font

License

See COPYING for details.

About

No description, website, or topics provided.

Resources

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
COPYING.md

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published