aboutsummaryrefslogtreecommitdiff
path: root/third-party
diff options
context:
space:
mode:
authorRich Wareham <rjw57@cam.ac.uk>2014-02-24 10:31:37 +0000
committerRich Wareham <rjw57@cam.ac.uk>2014-02-24 10:31:37 +0000
commit31cb3e09d47f2022c457a0f54a4dcb51cd4a79f4 (patch)
tree824820053c62b1730b52f1563eada63689f6389f /third-party
parentaad5f6341edb8fbe950fcc7c9a2b04bc62da4d82 (diff)
downloadrneovim-31cb3e09d47f2022c457a0f54a4dcb51cd4a79f4.tar.gz
rneovim-31cb3e09d47f2022c457a0f54a4dcb51cd4a79f4.tar.bz2
rneovim-31cb3e09d47f2022c457a0f54a4dcb51cd4a79f4.zip
third-party: add note on role of directory
Add a brief README on the purpose of the third-party directory and some suggestions for how to manage it. The neovim bigwigs may want to re-draft the README.
Diffstat (limited to 'third-party')
-rw-r--r--third-party/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/third-party/README.md b/third-party/README.md
new file mode 100644
index 0000000000..0d4c521e87
--- /dev/null
+++ b/third-party/README.md
@@ -0,0 +1,9 @@
+# Third party dependencies for neovim
+
+This directory contains any third party dependencies for neovim which, for one
+reason or another, we cannot rely on the system to supply.
+
+Ideally commits within this directory will only be merge commits from upstream
+projects. The "git subtree" tool is a good choice for managing such merge
+commits. In order to avoid needlessly inflating the bandwidth required to clone
+neovim, the ``--squash`` option for git subtree should be used.