Use bucket.yml.sample to step around git stuff

Instead of storing bucket.yml in the repo, where it might possibly clobber a user's settings if they do something stupid with git, store a sample file and include copying/renaming that file in the install instructions. .gitignore actual bucket.yml.
zigdon · Feb 4, 2015 · ab47f78 · ab47f78
1 parent 2441152
commit ab47f78
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+bucket.yml
+
diff --git a/README.md b/README.md
@@ -30,7 +30,9 @@ to work.
     $ mysql -D bucket < sample.sql```
 4. Create a user for Bucket, and grant all perms on the bucket database.
     `$ echo 'grant all on bucket.* to bucket identified by "s3kr1tP@ss"' | mysql`
-5. Edit config file (bucket.yml)
+5. Edit config file
+  1. Copy bucket.yml.sample -> bucket.yml
+  2. Edit bucket.yml and save
 6. Install perl modules.
     ```$ sudo cpan POE POE::Component::IRC POE::Component::SimpleDBI Lingua::EN::Conjugate Lingua::EN::Inflect 
     Lingua::EN::Syllable YAML HTML::Entities URI::Escape XML::Simple```

diff --git a/bucket.yml → bucket.yml.sample b/bucket.yml → bucket.yml.sample