Skip to content

Commit

Permalink
fix some capitalization, add bare bones readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ajul committed Oct 30, 2015
1 parent c63c096 commit a366e5a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/manual/api/section_package.tex
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ \subsubsection{\texttt{test} subpackages}
Subpackages named ``\texttt{test}'' generally contain Caliber scripts or unit tests. Most are out of date.

\subsection{Core logic}
These subpackages implement the core logic of caliber.
These subpackages implement the core logic of Caliber.
\subsubsection{\texttt{caliber.tree}}
This subpackage contains the \texttt{Tree} class, which defines the problem description.
\subsubsection{\texttt{caliber.node}}
Expand All @@ -22,7 +22,7 @@ \subsubsection{\texttt{caliber.opt}}
This subpackage contains the optimizer code.

\subsection{Helper functions}
These packages contain mostly small functions that are used in other parts of caliber.
These packages contain mostly small functions that are used in other parts of Caliber.
\subsubsection{\texttt{caliber.io}}
Functions here help process input to Caliber, or produce non-graphical output.
\subsubsection{\texttt{caliber.math}}
Expand Down
3 changes: 3 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
doc/: Documentation source.

src/: Source code (MATLAB). Look at the caliber.special package for examples of particular types of setups.

0 comments on commit a366e5a

Please sign in to comment.