From 58265453336a0db0dc1ea85edf2e483640b4e734 Mon Sep 17 00:00:00 2001 From: Nicolas Petton Date: Thu, 15 Jun 2017 16:17:49 +0200 Subject: [PATCH] Fix the readme --- README | 1 - README.md | 62 +------------------------------------------------------ 2 files changed, 1 insertion(+), 62 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index abfe257..0000000 --- a/README +++ /dev/null @@ -1 +0,0 @@ -My Emacs config \ No newline at end of file diff --git a/README.md b/README.md index 3e14f85..abfe257 100644 --- a/README.md +++ b/README.md @@ -1,61 +1 @@ -Assimilate Emacs packages as Git submodules -=========================================== - -*For more information see the [announcement][init] and the [manual].* - -About `borg.el` ---------------- - -[Borg][repo] is a bare-bones package manager for Emacs packages. It -provides only a few essential features and should be combined with -other tools such as Magit, `epkg`, `use-package`, and `auto-compile`. - -Borg assimilates packages into the `~/.emacs.d` repository as Git -submodules. An assimilated package is called a drone and a borg-based -`~/.emacs.d` repository is called a collective. - -About this collective ---------------------- - -This particular collective is intended to be used to bootstrap private -configurations. Fork your own copy and then start assimilating as you -please. - -If you wish you can later merge changes from the upstream repository, -to get updates for the drones that have been assimilated in the base -configuration. Very rarely additional drones might be assimilated or -the configuration of existing drones might be tweaked. - -Or you can just update and further configure these drones as you would -update the drones you have assimilated yourself. - -If you do base your own configuration on this collective and make it -publically available as source of inspiration for others, then please -do so by forking the upstream repository, which is available from -[Github][gh-this], [Gitlab][gl-this], and [Bitbucket][bb-this]. - -You might also want to adjust this description. - -Other collectives ------------------ - -It is also possible to create collectives that can be shared between -and worked on by many Emacs users, i.e. borg-based starter-kits. -Check out alternative collectives by browsing the repositories owned -by the `emacscollective` organisation/group/team, which is available -on [Github][gh-all], [Gitlab][gl-all], and [Bitbucket][bb-all]. - -Another alternative is the `bootstrap` collective. It assimilates a -single drone, `borg` itself, and is intended for users for whom even -the `emacs.g` collective is to opinionated. - -[init]: https://emacsair.me/2016/05/17/assimilate-emacs-packages-as-git-submodules -[repo]: https://gitlab.com/tarsius/borg -[manual]: https://emacsmirror.net/manual/borg - -[gh-this]: https://github.com/emacscollective/emacs.g -[gl-this]: https://gitlab.com/emacscollective/emacs.g -[bb-this]: https://bitbucket.com/emacscollective/emacs.g -[gh-all]: https://github.com/emacscollective -[gl-all]: https://gitlab.com/emacscollective -[bb-all]: https://bitbucket.com/emacscollective +My Emacs config \ No newline at end of file