Rename files expected to be user-edited to _example. Updated .gitigno…

…re to contain user and similar. Updated language of README.md to match user_example style. Should resolve ork#22
bdamm · Jul 24, 2018 · 426b915 · 426b915
1 parent e86d6c9
commit 426b915
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,6 @@
 header_cache
+user
+aliases
+gal
+mailing_lists
+signature
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Clone this repository into the `~/.mutt/` directory.
 
 ## Configuration
 
-Edit the `~/.mutt/user` file.
+Copy the `~/.mutt/user_example` file to `~/.mutt/user` location, then edit the `user` file.
 
 ```bash
 # User config
@@ -38,7 +38,7 @@ set my_password="This password is secure"
 set my_lang="fr_FR"
 ```
 
-Don't forget your `~/.mutt/signature` file.
+Don't forget your `~/.mutt/signature` file. Copy `signature`, `aliases`, and `mailing_lists` from the examples just like you did for `user`.
 Contacts and mailing-lists are stored in `~/.mutt/aliases` and `~/.mutt/mailing_lists`.
 
 ## Usage

diff --git a/aliases → aliases_example b/aliases → aliases_example
diff --git a/gal → gal_example b/gal → gal_example
diff --git a/mailing_lists → mailing_lists_example b/mailing_lists → mailing_lists_example
diff --git a/signature → signature_example b/signature → signature_example
diff --git a/user → user_example b/user → user_example