diff --git a/README.md b/README.md index d5c5076..95bdc60 100644 --- a/README.md +++ b/README.md @@ -55,9 +55,9 @@ However, try changing your engine to LuaLaTeX if something breaks. --------------------------------------------------------------------------- -# `ormc_handout` Documentation +# Class Documentation -This class is based on `article.cls`, and should work with most packages.\ +The class `ormc_handout` is based on `article.cls`, and should work with most packages.\ If something breaks, tell me so I may try to fix it. @@ -103,7 +103,7 @@ It also includes a few other packages that are used internally and shouldn't hav -**Basics:** +### **Basics:** - `\say{text}`: Puts text in quotes, handling details like period spacing. Courtesy of `dirtytalk`. - `\tab`: Typewriter-style tabs every `1cm`. Courtesy of `tabto`. @@ -116,7 +116,8 @@ It also includes a few other packages that are used internally and shouldn't hav -**Sectioning:**\ +### **Sectioning:** + The usual LaTeX title-customization techniques *WILL NOT WORK* with this class.\ Don't even try to load `titlesec`. @@ -138,7 +139,7 @@ Don't even try to load `titlesec`. -**Environments:** +### **Environments:** - `\begin{solution}`: A fancy `tcolorbox` for solutions to problems. \ This is hidden if the `nosolutions` flag is passed. @@ -147,6 +148,7 @@ Don't even try to load `titlesec`. - `\begin{examplesolution}`: A fancy `tcolorbox` for sample solutions. \ This is never hidden. -All of the above break across pages and may be safely nested. -They also define `\linehack`, which draws a line across the box.\ -Use `\linehack` replaces `tcolorbox` sections. `tcolorbox` only lets you have two, while `\linehack` gives you as many as you want. \ No newline at end of file +All the above environments break across pages and may be safely nested. + +Each also has a special command `\linehack`, which draws a line across the box.\ +Use `\linehack` instead of `tcolorbox` sections. `tcolorbox` only lets you have two, while `\linehack` gives you as many as you want. \ No newline at end of file