Artifact d4ea6985ffff006d31108e0704580bf345f96254:

• File README.md — part of check-in [0176d66ed0] at 2020-09-20 08:23:57 on branch trunk — README.md (Credits): Fix unquoted characters. (user: ams size: 2267)

<title>GNU Emacs Integration for Fossil</title>

This file contains a GNU Emacs VC backend for the Fossil version
control system.  You need GNU Emacs version 25.1 or later.

<h4>How Do I load Fossil support into emacs?</h4>

Short answer:

Install the vc-fossil package from the MELPA package repository then
customize the vc-handled-backend variable by adding "Fossil" to its
list of names.

Alternative, slightly longer, answer:

Instead of installing from MELPA you may clone this source repository
directly then add it manually to your Emacs setup as follows.

Add this to your .emacs file, or cut and paste this into the *scratch*
buffer and do
<code>C-x C-e</code> to execute it.

<pre>
(add-to-list 'vc-handled-backends 'Fossil t)
(load-file "/path/to/this/project/vc/el/vc-fossil.el")
</pre>

or if you would rather load the file lazily, compile the file (see
below) and use this instead.

<pre>
(add-to-list 'vc-handled-backends 'Fossil t)
(autoload 'vc-fossil-registered "/path/to/this/project/vc/el/vc-fossil.elc")
</pre>

To compile the file (with warnings) do the following

<pre>
emacs -batch -q -no-site-file -eval '(byte-compile-file "vc-fossil.el")'
</pre>

then you can load vc-fossil.elc, which should be nominally faster.

<h4>What emacs keys do I need?</h4>

This integrates fossil into emacs vc builtin mode.  The same keys will
work for fossil inside a fossil tree as for other SCMs.

A few are:

<table>
<tr><td><code>C-x v d</code></td><td>Run Fossil dired - like cvs-examine</td></tr>
<tr><td><code>C-x v l</code></td><td>When in a file, show log</td></tr>
<tr><td><code>v</code></td><td>In VC, do next action: merge/update/checkin</td></tr>
</table>

</table>

<h4>Credits</h4>

<ul>
  <li>Venkat Iyer &gt;venkat@comit.com&lt;:
      Original author.</li>
  <li>Alfred M. Szmidt : </li>
  <li>Barak A. Pearlmutter &gt;barak@pearlmutter.net&lt;:
    Major cleanup of my initial versions,</li>
  <li>Frank Fisher &gt;frank-fischer@shadow-soft.de&lt;:
    Colorized logs, annotate, fixes for diff output.</li>
  <li>Paul Onions, &gt;ponions37@gmail.com&lt;:
      GNU emacs 25 support.</li>
</ul>
    
<h4>Mirrors</h4>

If you're reading this on github, this is mirrored for MELPA from
https://chiselapp.com/user/venks/repository/emacs-fossil