spacemacs/layers/+pair-programming/floobits/README.org

44 lines
2.2 KiB
Org Mode

#+TITLE: Floobits layer
#+TAGS: layer|pairing
[[file:img/floobits.png]]
* Table of Contents :TOC_5_gh:noexport:
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#layer][Layer]]
- [[#key-bindings][Key bindings]]
* Description
This layer adds support for the peer programming tool [[https://github.com/Floobits/floobits-emacs][floobits]] to Spacemacs.
** Features:
- Loading of floobits configuration files with fixed commands
- Creation of floobits workspaces and populating it with content
- Marking of the current cursor position for all users within the current workspace
- Follow recent changes by other users
* Install
** Layer
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =floobits= to the existing =dotspacemacs-configuration-layers= list in this
file.
* Key bindings
| Key binding | Description |
|-------------+------------------------------------------------------------------------------------------|
| ~SPC P c~ | Clears all mirrored highlights. |
| ~SPC P d~ | Load the .floorc.json file for floobits configuration. |
| ~SPC P f~ | Follow a users changes. This also toggles follow mode. |
| ~SPC P j~ | Join an existing floobits workspace. |
| ~SPC P l~ | Leave the current workspace. |
| ~SPC P R~ | Create a workspace and populate it with the contents of the directory, DIR (or make it). |
| | The workspace will be shared privately. |
| ~SPC P s~ | Summon everyone in the workspace to your cursor position. |
| ~SPC P t~ | Toggle following of recent changes. |
| ~SPC P U~ | Create a workspace and populate it with the contents of the directory, DIR (or make it). |
| | The workspace will be shared publicly. |