README.md in flexdot-2.0.0 vs README.md in flexdot-3.0.0
- old
+ new
@@ -45,21 +45,21 @@
home_dir: '/home/username',
# (optional)
# The dotfile directory path.
# Default '.'.
- dotfiles_dir: '.',
-
- # (optional)
- # The `rake install` command will be available to install the dotfile for the specified index file.
- # Default nil.
- #
- # Note that the `rake install` command is always available if you have a single index file.
- default_index: 'name_of_an_index_file'
+ dotfiles_dir: '.'
)
```
+It is recommended that you add the Rakefile to `gitignore`:
+
+```
+# .gitignore
+Rakefile
+```
+
Finally, run `rake -T` in the `$HOME/dotfiles` and make sure that the output is as follows:
$ rake -T
rake clear_backups
@@ -122,22 +122,24 @@
```ruby
require 'flexdot'
Flexdot.setup(
- home_dir: '..',
- default_index: 'macOS'
+ home_dir: '..'
)
+
+# You can execute `install:macOS` when you run `rake` command
+# with no arguments by defining it as follows:
+task default: 'install:macOS'
```
### Available Commands
When you run the `rake -T` command in that directory structure, you should have two installation commands available:
$ rake -T
rake clear_backups # Clear all backups
- rake install # Install dotfiles for macOS
rake install:macOS # Install dotfiles for macOS
rake install:ubuntu # Install dotfiles for ubuntu
### Dotfile Index File
@@ -209,14 +211,14 @@
restart.sh: .xkeysnail
start.sh: .xkeysnail
stop.sh: .xkeysnail
```
-### Installing dotfiles
+### Installing dotfiles for macOS
- $ rake install
+ $ rake
-Or
+Or,
$ rake install:macOS
The following is the output result: