1 # vc-got
2 
3 This is an Emacs VC back-end for the [Game of
4 Tree](http://gameoftrees.org/) version control system.
5 
6 ------
7 
8 To start using it, you need to add `Got` to `vc-handled-backends` and
9 make sure that `vc-got` is within your `load-path`.  You shouldn't
10 require the library.
11 
12 ```emacs-lisp
13 (add-to-list 'vc-handled-backends 'Got)
14 ```
15 
16 It's highly recommended to add `".got"` to the list of
17 `vc-directory-exclusion-list`.
18 
19 ```emacs-lisp
20 (add-to-list 'vc-directory-exclusion-list ".got")
21 ```
22 
23 With `use-package` something like this should be enough:
24 
25 ```emacs-lisp
26 (use-package vc-got
27   :load-path "/path/to/vc-got/"
28   :defer t
29   :init
30   (add-to-list 'vc-handled-backends 'Got)
31   (add-to-list 'vc-directory-exclusion-list ".got"))
32 ```
33 
34 ## Drawbacks
35 
36 While I've been using this backend on a daily basis for the last
37 months, there are some rough edges.  Fetching updates in particular is
38 one action that *at the moment* is better to do by hand.  Pushing,
39 committing, blaming etc on the other hand are fully functional.
40 
41 Note that pushing requires at least got 0.56, other functionalities
42 should work with older versions.
43 
44 
45 ## Contributing
46 
47 The long-term plan is to get this into Emacs (or ELPA at least).  This
48 means that to avoid possible problems, a GNU copyright assignment is
49 required.  It's really easy to get one (just send an email), and
50 having one will allow you to make further contribution to Emacs itself
51 or to various other packages.