From 45a95eb525e2600f732b48931d3aa7f419534ec5 Mon Sep 17 00:00:00 2001 From: Jacob Date: Thu, 16 Oct 2025 21:30:22 -0400 Subject: [PATCH] Initial commit. --- .clang-format | 13 +++++++++++++ .clangd | 2 ++ .gitignore | 8 ++++++++ README.md | 15 +++++++++++++++ 4 files changed, 38 insertions(+) create mode 100644 .clang-format create mode 100644 .clangd create mode 100644 .gitignore create mode 100644 README.md diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..07403e6 --- /dev/null +++ b/.clang-format @@ -0,0 +1,13 @@ +--- +AlignConsecutiveShortCaseStatements: + Enabled: true + AcrossEmptyLines: true + AcrossComments: true +IndentCaseLabels: true +AllowShortBlocksOnASingleLine: Always +AllowShortCaseLabelsOnASingleLine: true +AllowShortIfStatementsOnASingleLine: AllIfsAndElse +AllowShortLoopsOnASingleLine: true +IndentWidth: 4 +PointerAlignment: Left +AlignAfterOpenBracket: BlockIndent diff --git a/.clangd b/.clangd new file mode 100644 index 0000000..8f7929a --- /dev/null +++ b/.clangd @@ -0,0 +1,2 @@ +CompileFlags: + Add: [-xc] diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0864e6c --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +*.o +*.so +tags +*.out +.cache +build/* +vgcore.* +compile_commands.json diff --git a/README.md b/README.md new file mode 100644 index 0000000..235e597 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Stug + +Study guide generator. + +## Purpose + +A study guide is not just a resource once completed; the process of +creating one is itself a tool to the creator. This project aims to reduce the +overhead of writing a study guide, so it may be of maximal educational utility. + +## Implementation Details + +Written in C. Converts markdown-like syntax to HTML, which is then hosted by +some static webserver TBD. Formulas are converted to MathML which is rendered +with javascript in the browser. Diagrams are rendered to SVG with Graphviz.