Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2019-09-25 21:06:17 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2019-09-25 21:06:17 +0300
commit3fdbfaf3e587a0e25b6351e72d19e3bc1b47b33e (patch)
tree02fe9c114e452965525422920a3addaa8eafe2bc /doc/development/projections.md
parentb1d7b01241da7f7f5d42c5ef46c7788fac0ab6d3 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/projections.md')
-rw-r--r--doc/development/projections.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/development/projections.md b/doc/development/projections.md
new file mode 100644
index 00000000000..9d5702da530
--- /dev/null
+++ b/doc/development/projections.md
@@ -0,0 +1,34 @@
+# Projections
+
+Projections are a way to define relations between files. Every file can have a
+"related" or "alternate" file. It's common to consider spec files to be
+"alternate" files to source files.
+
+## How to use it
+
+- Install an editor plugin that consumes projections
+- Copy `.projections.json.example` to `.projections.json`
+
+## How to customize it
+
+You can find a basic list of projection options in
+[projectionist.txt](https://github.com/tpope/vim-projectionist/blob/master/doc/projectionist.txt)
+
+## Which plugins can I use
+
+- vim
+ - [vim-projectionist](https://github.com/tpope/vim-projectionist)
+- VSCode
+ - [Alternate File](https://marketplace.visualstudio.com/items?itemName=will-wow.vscode-alternate-file)
+ - [projectionist](https://github.com/jarsen/projectionist)
+ - [jumpto](https://github.com/gmdayley/jumpto)
+- Atom
+ - [projectionist-atom](https://atom.io/packages/projectionist-atom)
+- Command-line
+ - [projectionist](https://github.com/glittershark/projectionist)
+
+## History
+
+This started as a
+[plugin for vim by tpope](https://github.com/tpope/vim-projectionist)
+It has since become editor-agnostic and ported to most modern editors.