HTML version of readmeHEADmaster

1 files changed, 64 insertions, 0 deletions

diff --git a/README.html b/README.html
new file mode 100644
index 0000000..1407c19
--- /dev/null
+++ b/README.html
@@ -0,0 +1,64 @@
+<h1 id="weekschedule">weekschedule</h1>
+<p>A LaTeX class for creating reasonably attractive (or at least not
+hideously ugly) schedules.</p>
+<h2 id="description">Description</h2>
+<p>I created the <code>weekschedule</code> class to make visual
+representations of my semester schedule to post on the door of my
+office. It supports a small range of options for configuring how the
+schedule renders, including 12 vs 24 hour time and 5 or 7 day weeks.
+It’s based on TikZ and produces a landscape, single page document ready
+for taping to any office door.</p>
+<p>This project was almost 100% vibe coded, so user beware. I seems to
+work fine for my use cases, but I have not pushed it terribly hard. If
+you do encounter any issues, feel free to reach out and I can take a
+look at getting it fixed. If you’re interested, it was made by first
+having Claude Sonnet create a one-off, hard coded schedule, and then
+having Opus write a class to emulate the schedule using an interface
+that I specified. It did take a little iteration, but the whole thing
+went surprisingly smoothly.</p>
+<h2 id="installation">Installation</h2>
+<p>LaTex looks for class files within the working directory, as well as
+within standardized directories (called a Tex tree) on your machine. The
+easiest way to use this class is to simply dump it into the same
+directory as the LaTex file you’re working on, and use
+<code>weekschedule</code> as the document class. You’ll need to refer to
+the documentation for your LaTex distribution for details on where to
+put the <code>.cls</code> file for systemwide use.</p>
+<h2 id="using-examples">Using Examples</h2>
+<p>Example files are located in the <code>examples/</code> directory.
+They can be compiled directory from the project root using,</p>
+<div class="sourceCode" id="cb1"><pre
+class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> pdflatex examples/weekly_schedule.tex</span></code></pre></div>
+<h2 id="quick-start">Quick Start</h2>
+<div class="sourceCode" id="cb2"><pre
+class="sourceCode latex"><code class="sourceCode latex"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="bu">\documentclass</span>{<span class="ex">weekschedule</span>}</span>
+<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="fu">\scheduletitle</span>{My Weekly Schedule}</span>
+<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="fu">\timefrom</span>{8:00}</span>
+<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="fu">\timeto</span>{17:00}</span>
+<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="fu">\twelvehourtime</span></span>
+<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="fu">\eventclass</span>{Work}{255,200,200}</span>
+<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="fu">\event</span>{Work}{Meeting}{Monday}{9:00}{10:00}</span>
+<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a><span class="kw">\begin</span>{<span class="ex">document</span>}</span>
+<span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a><span class="fu">\printschedule</span></span>
+<span id="cb2-13"><a href="#cb2-13" aria-hidden="true" tabindex="-1"></a><span class="kw">\end</span>{<span class="ex">document</span>}</span></code></pre></div>
+<h2 id="documentation">Documentation</h2>
+<p>Out of laziness, I AI generated some docs. I’ll eventually get around
+to writing “real” documentation, but for now this appears correct and
+may be useful. The slop docs are available in the <code>doc/</code>
+directory.</p>
+<h2 id="todo">TODO</h2>
+<p>There are a couple of specific features that are currently missing
+from the class.</p>
+<ul>
+<li>Support for overlapping events</li>
+<li>Actual documentation–the existing docs file was one-shot AI
+generated from the source code.</li>
+</ul>
+<h2 id="license">License</h2>
+<p>Copyright (c) 2026, Douglas B. Rumbaugh</p>
+<p>This work is licensed under the Modified BSD License (3-clause BSD
+License). See the <code>LICENSE</code> file for the full license
+text.</p>