29 lines
1.4 KiB
TeX
29 lines
1.4 KiB
TeX
%% SCRAP: architecture/getting-started/README
|
|
%% SOURCE: docs/working/architecture/getting-started/README.md
|
|
%% STATUS: SUPERSEDED
|
|
%% FITS: dev-guide/ch-install
|
|
%% EDITORIAL: lifted — prose rewritten to press voice
|
|
|
|
\section{Getting Started: Orientation}
|
|
|
|
%% This source is a directory-index README. Its substantive content is the
|
|
%% Developer Guide (see DEVELOPER scrap) plus the quick-start experiment guides;
|
|
%% in the formal doc set it is superseded by those chapters. Retained here only
|
|
%% as a brief signpost.
|
|
|
|
The getting-started material orients new users and developers. The developer
|
|
setup and contribution workflow are covered in the Developer Environment
|
|
chapter. Three quick-start guides walk through running experiments:
|
|
|
|
\begin{itemize}
|
|
\item Factorial Design of Experiments --- the $2^7$ factorial harness.
|
|
\item Heartbeat logging experiments.
|
|
\item Physics-optimization experiments.
|
|
\end{itemize}
|
|
|
|
From here, readers proceed to the experimental protocols to run their own
|
|
experiments, the architecture documentation to understand the system
|
|
internals, and the source-code reference for detailed technical material.
|
|
|
|
%% TODO(bob): this index README is redundant with DEVELOPER and the quick-start guides. Confirm it should be folded into ch-install rather than carried as its own section, and point the three quick-start bullets at their promoted formal locations.
|