From 3221f1bf740be0aec0b1fa2503907e15336212fb Mon Sep 17 00:00:00 2001 From: Satu Koskinen Date: Mon, 24 Oct 2022 18:37:56 +0300 Subject: [PATCH] Move docs to their own folder, clean up --- README.md | 2 +- notes.md => docs/notes.md | 0 resources.md => docs/resources.md | 0 setup.md => docs/setup.md | 0 recording.md | 0 todo.md | 23 ----------------------- 6 files changed, 1 insertion(+), 24 deletions(-) rename notes.md => docs/notes.md (100%) rename resources.md => docs/resources.md (100%) rename setup.md => docs/setup.md (100%) delete mode 100755 recording.md delete mode 100644 todo.md diff --git a/README.md b/README.md index f8263fd..a049b5f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A software package to record audio and related metadata from a configuration of hydrophones. -For setup instructions, see `setup.md`. +For setup instructions, see `docs/setup.md`. ## Overview diff --git a/notes.md b/docs/notes.md similarity index 100% rename from notes.md rename to docs/notes.md diff --git a/resources.md b/docs/resources.md similarity index 100% rename from resources.md rename to docs/resources.md diff --git a/setup.md b/docs/setup.md similarity index 100% rename from setup.md rename to docs/setup.md diff --git a/recording.md b/recording.md deleted file mode 100755 index e69de29..0000000 diff --git a/todo.md b/todo.md deleted file mode 100644 index 182c6d1..0000000 --- a/todo.md +++ /dev/null @@ -1,23 +0,0 @@ -# To do list - -- [ ] Configurable, documented setup process for the Raspberry Pi - - [ ] Setup script - - [ ] Copy executables & scripts - - [ ] Required packages to install - - [ ] System configurations - - [ ] Configurable values - - [ ] Test -- [ ] Output formats & location for output data - - [ ] Automatic SSD mounting -- [ ] Audio recording - - [ ] Logging - - [ ] Test -- [ ] GPS recording - - [ ] Logging - - [ ] Test -- [ ] Depth recording - - [ ] Double check formulas to calculate depth & pressure from voltage - - [ ] Logging - - [ ] Test -- [ ] Test autonomous recording as a whole -