msqur/doxygen/latex/md__r_e_a_d_m_e.tex

54 lines
1.7 KiB
TeX

\textquotesingle{}Masker\textquotesingle{} for lack of better name. Mega\+Squirt \hyperlink{class_m_s_q}{M\+S\+Q} file sharing and viewing site.
Parses \hyperlink{class_m_s_q}{M\+S\+Q} \char`\"{}\+X\+M\+L\char`\"{} and displays it in a familiar format for viewing and comparison.
\hyperlink{class_m_s_q}{M\+S\+Q} X\+M\+L is pretty bad X\+M\+L, it doesn\textquotesingle{}t take advantage of many X\+M\+L features.
\section*{T\+O\+D\+O}
Uploader (user)/\+Manager (admin)
\subsubsection*{How do I get set up?}
\begin{DoxyItemize}
\item A\+M\+P Stack
\item Arch\+: P\+H\+P, P\+H\+P-\/\+Apache, Maria\+D\+B/\+My\+S\+Q\+L, php\+My\+Admin, pdo\+\_\+mysql.\+so in php.\+ini
\item Create database user and tables
\item Upload web files
\item How to run tests
\end{DoxyItemize}
\subsubsection*{hgrc}
\mbox{[}hooks\mbox{]} post-\/update = hg log -\/r . --template \char`\"{}v\{latesttag\}-\/\{latesttagdistance\}-\/\{node$\vert$short\}\textbackslash{}n\char`\"{} $>$ V\+E\+R\+S\+I\+O\+N
\subsubsection*{Deployment instructions}
\begin{DoxyItemize}
\item Export tables (not entire D\+B)
\item Pull updates on host (don\textquotesingle{}t overwrite D\+B config)
\item Import D\+B
\end{DoxyItemize}
\subsubsection*{Contribution guidelines}
\begin{DoxyItemize}
\item Writing tests
\item Code review
\item Other guidelines
\end{DoxyItemize}
\subsubsection*{Who do I talk to?}
\begin{DoxyItemize}
\item Repo owner or admin
\item Other community or team contact
\end{DoxyItemize}
\subsubsection*{Credits}
Apache, P\+H\+P, My\+S\+Q\+L j\+Query, j\+Query U\+I jquery.\+tablesorter \href{http://tablesorter.com/docs/}{\tt http\+://tablesorter.\+com/docs/} Tango Icon Theme Geany/\+Notepad++