Update README.md

README.md

@@ -3,7 +3,7 @@ configs:
 - config_name: default
   data_files: "data.csv"
   delimiter: "|"
-  header: 0
+  header: 1
   names: ["kind", "sound"]
 size_categories:
 - n<1K
@@ -11,4 +11,33 @@ size_categories:
 
 # [doc] formats - csv - 3
 
-This dataset contains one csv file at the root. We provide several options in the YAML config (`"|"` delimiter, name of the columns, index of the header row). The reference for the options is the [documentation of pandas.read_csv()](https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html).
+
+This dataset contains one csv file at the root:
+
+- [data.csv](./data.csv)
+
+```csv
+# ignored comment
+col1|col2
+dog|woof
+cat|meow
+pokemon|pika
+human|hello
+```
+
+We define the config name in the YAML config, as well as the exact location of the file, the separator as `"|"`, the name of the columns, and the number of rows to ignore (the row #1 is a row of column headers, that will be replaced by the `names` option, and the row #0 is ignored). The reference for the options is the [documentation of pandas.read_csv()](https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html).
+
+```yaml
+---
+configs:
+- config_name: default
+  data_files: "data.csv"
+  delimiter: "|"
+  header: 1
+  names: ["kind", "sound"]
+size_categories:
+- n<1K
+---
+```
+
+