Added Readme
[vagrant-dotfiles.git] / README.md
1 # CopyMyConf
2
3 Now you can copy your dotfiles into your vagrant box, so that you don't feel like visiting Mars whenever you are in vagrant shell.
4
5 ## How to Use
6
7 It is a simple 3 step process
8
9 ### Add gem in your vagrant
10
11 $ vagrant gem install copy_my_conf
12
13 ### Add provisioner in your Vagrantfile
14
15 Add these lines in your vagrant file inside the `Vagrant::Config.run` block
16
17 config.vm.provision CopyMyConf do |copy_conf|
18 copy_conf.git = true
19 copy_conf.vim = true
20 copy_conf.ssh = true
21 end
22
23 Don't worry if you have any other provisioners, vagrant can work with multiple provisioners. Yay \o/
24 As you might have guessed, If you make any of these false, the corresponding files won't be copied
25
26 If home directory of the user is not `/home/vagrant` then you can specify that using the `user_home` option in above code
27
28 copy_conf.user_home = '/home/some_other_user'
29
30 ### Fire !
31
32 $ vagrant up
33
34 And you'll be good to go.
35
36 ## Feedback
37 This is my first gem so any kind of feedback would be appreciated.
38 Feel free fork, edit and send pull requests.
39
40 ## Copyrights & Author
41
42 Copyright(c) 2013 Akshay Mankar <itsakshaymankar@gmail.com>
43 License: [MIT License](http://mit-license.org/)