Create README about generating data sets

AnjanaSenanayake · Mar 6, 2020 · 51a1f73 · 51a1f73
1 parent b21a9a8
commit 51a1f73
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/scripts/README.md b/scripts/README.md
@@ -0,0 +1,19 @@
+## Generating data sets to use in F5N
+
+`generate-datasets.sh` script will generate zipped data sets which can be used in F5N server and F5N mobile application.
+Inorder to use the above script you need to have a folder structure as given below.
+
+```bash
+├── fastq
+│   ├── 1
+│   │   ├── *.fastq (multiple files)
+│   └── 2
+│   │   ├── *.fastq (multiple files)
+│   .
+.   
+├── 1
+│   ├── *.fast5 (single files)
+└── 2
+│   ├── *.fast5 (single files)
+.
+```