Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding installation instructions using git or git+borg #299

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,53 @@ lines to your personal Emacs initialization file,
Restart Emacs and you should see the "Hypb" hyperbole minor mode
indicator in your modeline after startup.

** Building manually from git (using git submodules and/or borg)

If you prefer work directly with the git and the raw files with a
minimal package manager or none at all

1. Clone the Hyperbole repo in your emacs config directory
run borg-assimalte on the Hyperbole package to install it
{M-x borg-assimilate RET hyperbole RET}

or from the cli in your git directory
git submodule add --name compat \
[email protected]:emacsmirror/compat.git lib/compat

2. Link and get Hyperbole ready for Emacs
lets add some additional lines to your .gitmodules file in the
Hyperbole section
[submodule "hyperbole"]
path = lib/hyperbole
url = https://git.savannah.gnu.org/git/hyperbole.git

To look like this
[submodule "hyperbole"]
path = lib/hyperbole
url = https://git.savannah.gnu.org/git/hyperbole.git
load-path = ./
load-path = ./kotl
info-path = man
build-step = make

And and finally lets enable Hyperbole by adding this elsip to your init.el
(require 'hyperbole)
(hyperbole-mode 1)

If you want to link it up by hand without borg here is your Elsip
ELISP goes here
(add-to-list 'load-path (expand-file-name "lib/hyperbole/" user-emacs-directory))
(add-to-list 'load-path (expand-file-name "lib/hyperbole/kotl/" user-emacs-directory))
(require 'hyperbole)
(hyperbole-mode 1)

3. If you want even more performance from Hyperbole should byte-compile Hyperbole
build Hyperbole using borg
{M-x borg-build RET hyperbole RET}

Or you can cd to the directory in your shell and use the included makefile
make

===========================================================================
* Browsing the Source
===========================================================================
Expand Down