commit 2b7241ac6d9a243350bf7e7c5f292de7d909ad6e from: Omar Polo date: Sun Feb 14 17:46:43 2021 UTC revamp readme commit - cb9738320a3eccea0ff0de41159e8c95bc5201f0 commit + 2b7241ac6d9a243350bf7e7c5f292de7d909ad6e blob - 9fddaadadcb564ce1e5273cf28673e9fb4b3c98a blob + 7e63da373d0143176cff928d7f44a219f7d03eb9 --- README.md +++ README.md @@ -1,6 +1,6 @@ # vc-got -This is an **experimental** Emacs VC back-end for the [Game of +This is an Emacs VC back-end for the [Game of Tree](http://gameoftrees.org/) version control system. ------ @@ -31,7 +31,14 @@ With `use-package` something like this should be enoug (add-to-list 'vc-directory-exclusion-list ".got")) ``` +## Drawbacks +While I've been using this backend on a daily basis for the last +months, there are some rough edges. Fetching updates in particular is +one action that *at the moment* is better to do by hand. Pushing, +committing, blaming etc on the other hand are fully functional. + + ## Stage hunks Unlike other VC backends, `vc-got` is able to stage and commit @@ -55,3 +62,12 @@ and an example of the interactive stage operation with ![interactive stage operation](images/vc-got-stage-files.png "interactive stage operation") + + +## Contributing + +The long-term plan is to get this into Emacs. This means that to +avoid possible problem, a GNU copyright assignment is required. It's +really easy to get one (just send an email), and having one will allow +you to make further contribution to Emacs itself or to various +other packages.