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