tex

doc/bundles.tex

@@ -0,0 +1,21 @@
+\section{Bundles}
+
+\subsection{Single-File Bundles with MAD}
+
+The key feature of mad is ability to create single-file bundled web sites.
+Thus making dream to boot simpler than node.js come true.
+This target escript is ready to run on Windows, Linux and Mac.
+
+To make this possible we implemented a zip filesytem inside escript.
+mad packages priv directories along with ebin and configs.
+You can redefine each file in zip fs inside target
+escript by creation the copy with same path locally near escript.
+After launch all files are copied to ETS.
+N2O also comes with custom cowboy static handler that is able to
+read static files from this cached ETS filesystem.
+Also bundle are compatible with active online realoading and recompilation.
+
+\subsection{Releases with RELX}
+
+\subsection{Re with OTP.MK}
+

doc/commands.tex

@@ -0,0 +1,30 @@
+\section{Commands}
+
+Synrc mad has a simple interface as follows:
+
+\vspace{1\baselineskip}
+\begin{lstlisting}
+  BNF:
+      invoke := mad params
+      params := [] | run params
+         run := command [ options ]
+     command := app | lib | deps | compile | bundle
+                start | stop | repl
+\end{lstlisting}
+\vspace{1\baselineskip}
+
+It seems to us more natural, you can specify random
+commands set with different specifiers (options).
+
+\subsection{deps}
+
+\subsection{compile}
+
+\subsection{plan}
+
+\subsection{repl}
+
+\subsection{bundle}
+
+\subsection{app}
+

doc/deps.tex

@@ -0,0 +1,42 @@
+\section{Dependencies}
+
+\subsection{OTP Compliant}
+
+mad supports rebar umbrella project structure.
+Specifically two kinds of directory layouts:
+
+\vspace{1\baselineskip}
+\begin{lstlisting}[caption=Solution]
+    ├── apps
+    ├── deps
+    ├── rebar.config
+    └── sys.config
+\end{lstlisting}
+\vspace{1\baselineskip}
+
+\vspace{1\baselineskip}
+\begin{lstlisting}[caption=OTP Application]
+    ├── deps
+    ├── ebin
+    ├── include
+    ├── priv
+    ├── src
+    └── rebar.config
+\end{lstlisting}
+\vspace{1\baselineskip}
+
+\subsection{Apps Ordering}
+
+As you may know you can create OTP releases with
+reltool (rebar generate) or systools (relx). mad currently
+creates releases with relx but is going to do it independently soon.
+Now it can only order applications.
+
+\vspace{1\baselineskip}
+\begin{lstlisting}
+    # mad plan
+    Ordered: [kernel,stdlib,mnesia,kvs,crypto,cowlib,ranch,
+              cowboy,compiler,syntax_tools,erlydtl,gproc,
+              xmerl,n2o,n2o_sample,fs,active,mad,rest,sh]
+\end{lstlisting}
+\vspace{1\baselineskip}

doc/setup.tex

@@ -6,8 +6,8 @@ Fresh version of mad included as a binary in its primary github repository:
 
 \vspace{1\baselineskip}
 \begin{lstlisting}
-    # curl -fsSL https://raw.github.com/synrc/mad/master/mad > mad\\
-              && chmod +x mad \\
+    # curl -fsSL https://raw.github.com/synrc/mad/master/mad > mad \
+              && chmod +x mad \
               && sudo cp /usr/local/bin
 \end{lstlisting}
 \vspace{1\baselineskip}

doc/web/bundles.tex

@@ -9,7 +9,6 @@
 \input{toc}
 %HEVEA \begin{divstyle}{articlecol}
 \include{../bundles}
-%HEVEA \rawhtmlinput{templates/mad-comments.htx}
 %HEVEA \rawhtmlinput{templates/disqus.htx}
 %HEVEA \end{divstyle}
 %HEVEA \end{divstyle}

doc/web/commands.tex

@@ -9,7 +9,6 @@
 \input{toc}
 %HEVEA \begin{divstyle}{articlecol}
 \include{../commands}
-%HEVEA \rawhtmlinput{templates/mad-comments.htx}
 %HEVEA \rawhtmlinput{templates/disqus.htx}
 %HEVEA \end{divstyle}
 %HEVEA \end{divstyle}

doc/web/config.tex

@@ -9,7 +9,6 @@
 \input{toc}
 %HEVEA \begin{divstyle}{articlecol}
 \include{../config}
-%HEVEA \rawhtmlinput{templates/mad-comments.htx}
 %HEVEA \rawhtmlinput{templates/disqus.htx}
 %HEVEA \end{divstyle}
 %HEVEA \end{divstyle}

doc/web/deps.tex

@@ -9,7 +9,6 @@
 \input{toc}
 %HEVEA \begin{divstyle}{articlecol}
 \include{../deps}
-%HEVEA \rawhtmlinput{templates/mad-comments.htx}
 %HEVEA \rawhtmlinput{templates/disqus.htx}
 %HEVEA \end{divstyle}
 %HEVEA \end{divstyle}

doc/web/ports.tex

@@ -9,7 +9,6 @@
 \input{toc}
 %HEVEA \begin{divstyle}{articlecol}
 \include{../ports}
-%HEVEA \rawhtmlinput{templates/mad-comments.htx}
 %HEVEA \rawhtmlinput{templates/disqus.htx}
 %HEVEA \end{divstyle}
 %HEVEA \end{divstyle}

doc/web/scripts.tex

@@ -9,7 +9,6 @@
 \input{toc}
 %HEVEA \begin{divstyle}{articlecol}
 \include{../scripts}
-%HEVEA \rawhtmlinput{templates/mad-comments.htx}
 %HEVEA \rawhtmlinput{templates/disqus.htx}
 %HEVEA \end{divstyle}
 %HEVEA \end{divstyle}

doc/web/setup.tex

@@ -9,7 +9,6 @@
 \input{toc}
 %HEVEA \begin{divstyle}{articlecol}
 \include{../setup}
-%HEVEA \rawhtmlinput{templates/mad-comments.htx}
 %HEVEA \rawhtmlinput{templates/disqus.htx}
 %HEVEA \end{divstyle}
 %HEVEA \end{divstyle}