From 0279a60a550945197f723fb91bd2b1f09dd1d0d3 Mon Sep 17 00:00:00 2001 From: David Nadlinger Date: Tue, 17 Dec 2019 13:28:38 +0000 Subject: [PATCH] examples: Add README This will be displayed by GitHub below the directory listing, and was inspired by observing new users disregard the examples/ tree entirely (even though the experiments and device DBs within would have cleared up their getting-started confusion) due to the perceived complexity wall induced by the wealth of subdirectories. --- artiq/examples/README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 artiq/examples/README.rst diff --git a/artiq/examples/README.rst b/artiq/examples/README.rst new file mode 100644 index 000000000..4a37fd15c --- /dev/null +++ b/artiq/examples/README.rst @@ -0,0 +1,11 @@ +ARTIQ experiment examples +========================= + +This directory contains several sample ARTIQ master configurations +and associated experiments that illustrate basic usage of various +hardware and software features. + +New users might want to peruse the ``no_hardware`` directory to +explore the argument/dataset machinery without needing access to +hardware, and the ``kc705_nist_clock`` directory for inspiration +on how to coordinate between host and FPGA core device code.