summaryrefslogtreecommitdiff
path: root/sample.conf
diff options
context:
space:
mode:
authorNullspoon <nullspoon@iohq.net>2014-08-26 21:49:30 -0600
committerNullspoon <nullspoon@iohq.net>2014-08-26 21:53:04 -0600
commite9fa24b8cb4a3d0dd01040695c5d021b9671216c (patch)
treebbe4eb493261046cc6b653acbdc603209d91b818 /sample.conf
parentc75671efcccf6c47655b5c51e97f9df9ab928e1a (diff)
downloadnoteless-e9fa24b8cb4a3d0dd01040695c5d021b9671216c.tar.gz
noteless-e9fa24b8cb4a3d0dd01040695c5d021b9671216c.tar.xz
Added sane defaults for all main variables
This specifically is editor, note_path, and extension. With these sane defaults, the user doesn't even need the config file. If they want to override, they can use system variables or the config file now. Updated the sample.conf file to reflect all of the new changes.
Diffstat (limited to 'sample.conf')
-rw-r--r--sample.conf16
1 files changed, 12 insertions, 4 deletions
diff --git a/sample.conf b/sample.conf
index f9b631f..5406978 100644
--- a/sample.conf
+++ b/sample.conf
@@ -1,9 +1,17 @@
-# This should be placed at $HOME/.config/noteless.conf
-# Required keys are "path" and "extension"
+# This config file is for overriding any defaults.
+# It is NOT necessary
+#
+# To use this, place it at $HOME/.config/noteless.conf and change variables as
+# wanted.
# Path to store the notes in
-# Note required as the default is ~/Documents/Notes
+# Default: ~/Documents/Notes
#path = /home/username/Documents/Notes
# Extension of all notes
-extension = mdown
+# Default: mdown
+#extension = mdown
+
+# Path to the editor
+# Default: vi (unless environmental variable EDITOR is set)
+# editor = vim

Generated by cgit