Browse Source

change markup flavor from 'pandoc' to 'github'

mostly in the table
Pat Beirne 1 year ago
parent
commit
25fa1d8fb8
1 changed files with 11 additions and 8 deletions
  1. 11 8
      README.md

+ 11 - 8
README.md

@@ -62,14 +62,17 @@ The comments are stored in an Sqlite3 database, usually located at "~/.dirnotes.
     CREATE TABLE dirnotes (name TEXT, date DATETIME, size INTEGER, comment TEXT, comment_date DATETIME, author TEXT)
 ~~~~
 
-field         usage                                                  example  
-------        -------                                                ---------
-name          the long filename, using python's os.path.abspath()    /home/patb/projects/dirnotes/README.md  |
-date          the file's modified date                               2020-01-13 09:25:40 
-size          the byte count of the file                             145  
-comment       a utf-8 string                                         the readme for the GIT page  
-comment_date  the date of the comment itself                         2020-10-03 22:30:19 
-author        the system name of the user who created the comment    patb  
+
+| field | usage | example |
+| -------- | -------- | -------- |
+| name   |       the long filename, using python's os.path.abspath() |   /home/patb/projects/dirnotes/README.md | 
+|date    |      the file's modified date  |                             2020-01-13 09:25:40 |
+|size   |      the byte count of the file       |                      145  |
+|comment     |  a utf-8 string |                                         the readme for the GIT page | 
+|comment_date | the date of the comment itself   |                      2020-10-03 22:30:19 |
+|author     |   the system name of the user who created the comment  |  patb | 
+
+
 
 The 'date' and 'size' fields reflect the file's modification date and size at the time of the last edit of the file comment, which is also 'comment_date'.