rename example config (fixes #2)

jwoytek · May 16, 2023 · 5a6d4e5 · 5a6d4e5
1 parent 1c94bb3
commit 5a6d4e5
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+# ignore site config
+showtimer.yaml
+
 # If you prefer the allow list template instead of the deny list, see community template:
 # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
 #

diff --git a/README.md b/README.md
@@ -21,7 +21,8 @@ Currently, most setup and startup of the program must be done from the
 command line (Windows CMD.EXE, MacOS Terminal, etc.). 
 
 1. unzip the bundle in a useful location, like your home directory
-2. Edit the `showtimer.yaml` file with your favorite editor
+2. Copy `showtimer_example.yaml` to a name of your choice. The default
+   is `showtimer.yaml`. Edit the file with your favorite editor.
 3. Set the port values for the webserver and OSC (or note the defaults)
 4. Optionally, if you would like to only listen on a certain interface,
    enter the IP address of that interface. This is probably not common.

diff --git a/showtimer.yaml → showtimer_example.yaml b/showtimer.yaml → showtimer_example.yaml
@@ -4,6 +4,7 @@ web:
 osc:
   #bind: 0.0.0.0
   port: 8000
+darkmode: false
 timers:
   - name: Act 1
     key: act1