Adhalianna / wit

Repository dependencies and recommended software

Build dependencies

• just command runner, inspired by make, convienient automation of mundane tasks.
• typst a LaTeX alternative, the free CLI application can be used to render the documents with .typ extension to PDF files.
• d2 simple diagram scripting language and a compiler.
• Rust the programming language used in the implementation, as a result of proper instalation multiple binaries should be available including: rustup, cargo.

Recommended software

• watchexec

  # Example. Run in the root of the repository.
  watchexec just render-design

• Sioyek a minimalistic PDF viewer which reloads content on changes. When used in combination with watchexec and proper just command it allows for "hot-reloading" the PDFs as they get edited.

Repository structure

.
├── docs      # thesis paper and any related to project documents
├── src       # source code of the implementation
├── (target)  # __generated__ by cargo, contains compilation artifacts
└── tests     # test files
.gitignore
justfile      # defines commands available through just
(Cargo.lock)  # __generated__ by cargo, lists resolved dependencies
Cargo.toml    # Rust project manifest