Explorar o código

Add README to example root dir

Jeffrey Gill %!s(int64=4) %!d(string=hai) anos
pai
achega
f91bb996c6
Modificáronse 1 ficheiros con 13 adicións e 0 borrados
  1. 13 0
      examples/README.md

+ 13 - 0
examples/README.md

@@ -0,0 +1,13 @@
+# neurotic Examples
+
+To download and view these examples using **neurotic**:
+
+1. Install the latest version of **neurotic**: https://neurotic.readthedocs.io/en/latest/install.html
+2. Start **neurotic**. A list of examples will load automatically.
+3. Diamond icons to the left of each data set are filled (◆) if the data files are already on your computer, and empty (◇) if not.
+4. To download files, select a data set with an empty diamond (◇) and click "Download data". Download progress is reported in the console window.
+5. To view an example, select a data set with a filled diamond (◆) and click "Launch".
+
+---
+
+This file is part of the **neurotic-data** repository: https://gin.g-node.org/jpgill86/neurotic-data