Initial commit.
This commit is contained in:
13
.clang-format
Normal file
13
.clang-format
Normal file
@@ -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
|
||||||
8
.gitignore
vendored
Normal file
8
.gitignore
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
*.o
|
||||||
|
*.so
|
||||||
|
tags
|
||||||
|
*.out
|
||||||
|
.cache
|
||||||
|
build/*
|
||||||
|
vgcore.*
|
||||||
|
compile_commands.json
|
||||||
15
README.md
Normal file
15
README.md
Normal file
@@ -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.
|
||||||
Reference in New Issue
Block a user