Skip to content

MinkTec/whitepaper

Repository files navigation

FlexTail Whitepaper

Three-Dimensional Spinal Shape Reconstruction for Ambulatory Biomechanics

Built with LaTeX using the Tectonic typesetting engine and the rectify-whitepaper template.


Building Locally

Prerequisites:

  • just — command runner
  • tectonic — LaTeX engine (handles package downloads automatically)

Build the PDF:

just build

This reads the version from VERSION, writes src/version.tex, and compiles the document. The output is placed in build/FlexTail_Whitepaper/FlexTail_Whitepaper.pdf.


Releasing a New Version

  1. Update VERSION with the new version number (e.g. 0.1.0):

    echo "0.1.0" > VERSION
  2. Commit the change:

    git add VERSION
    git commit -m "chore: bump version to 0.1.0"
  3. Tag and push:

    just release

    This creates a v<version> tag and pushes it to origin.

The CI pipeline (.github/workflows/build.yml) triggers on any tag push. It builds the PDF with Tectonic and creates a GitHub Release with the PDF attached automatically.


Project Structure

src/            LaTeX source files
  index.tex     Main document entry point
  refs.bib      BibTeX bibliography
  sections/     Chapter/section files
assets/         Logos and images
ref/            Reference PDFs
build/          Compiled output (generated, not committed)
Tectonic.toml   Tectonic project configuration
VERSION         Current version string (e.g. 0.0.1)
justfile        Build and release recipes

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors