competition hackpack used by CU Cyber
Switch branches/tags
Clone or download

README.md

CU Cyber Hackpack

In this repository are the markdown sources to the hackpack used by CU Cyber in general and at competitions. An up-to-date build of the hackpack is available in HTML at https://cucyber.net/documents/hackpack.html and in PDF at https://cucyber.net/documents/hackpack.pdf.

Dependencies

  • make
  • git
  • rsync
  • python3
  • pandoc
  • pandocfilters
  • texlive-latexextra
  • python3-watchdog (optional; for automatic rebuilding on presentation change)

Debian/Ubuntu/Kali

$ sudo apt install make git python3 pandoc python3-pandocfilters texlive-latex-extra python3-watchdog

RedHat/CentOS

$ sudo yum install epel-release
$ sudo yum install make git python34 pandoc texlive-collection-latexextra
$ sudo pip3 install pandocfilters
$ sudo pip3 install watchdog

Fedora

$ sudo dnf install make git pandoc python3-pandocfilters texlive-collection-latexextra python3-watchdog

Arch

$ sudo pacman -S make git pandoc python-pandocfilters texlive-latexextra python-watchdog

Gentoo

$ sudo emerge dev-vcs/git dev-lang/python:3.4 app-text/pandoc dev-texlive/texlive-latexextra dev-python/watchdog
$ sudo pip3 install pandocfilters

macOS

Requires Homebrew and Homebrew Cask. Use gmake instead of make.

$ brew install make git python2 python3 pandoc
$ brew cask install mactex
$ pip3 install pandocfilters
$ pip3 install watchdog

Preparation

You must clone the website repository adjacent to the hackpack repository with the name 'website' to use make serve and make update.

$ git clone https://github.com/CUCyber/cucyber.github.io.git website
$ git -C website checkout dev

Downloading

$ git clone https://github.com/CUCyber/hackpack.git

Building

To build the entire hackpack into a single pdf file, edit the 'makefile' as desired and run make.

Testing

To build the entire hackpack and open the pdf file, edit the 'makefile' as desired and run make open.

Updating

To build the entire hackpack and upload it to the website automatically, edit the 'makefile' as desired and for the website git repository location and run make update. You must have push access to the repository at the specified directory.

Cleaning

To clean out any generated files, run make clean.