Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

docs: INSTALL etc.

  • Loading branch information...
commit 2bd45eb7bad7e4c91a7fc8c04883153b5fc4045f 1 parent 61a5020
@tomtom authored
Showing with 64 additions and 27 deletions.
  1. +56 −25 INSTALL.TXT
  2. +8 −2 README
View
81 INSTALL.TXT
@@ -1,40 +1,76 @@
* Install from GIT
-This repository includes several plugins. I am well aware that this is
-bad practice. Anyway, here are a few suggestions of how to make use of
-this repository:
-
-
-
-** RECOMMENDED: Use macros/tplugin.vim
+Let's assume that you downloaded some VIM plugins from
+https://github.com/tomtom to your harddisk. The directory structure
+could then look like this:
+
+#Verb <<
+ ~/
+ .vim/
+ autoload/
+ bundles/
+ tlib_vim/
+ .git/
+ autoload/
+ docs/
+ plugins/
+ tcomment_vim/
+ .git/
+ autoload/
+ docs/
+ plugins/
+ ...
+ docs/
+ plugins/
+ ...
+
+Please find below a few remarks on how to use VIM plugins in such an
+alternative directory structure. ''pathogen'' probably is the simplest
+solution to make this work. Since it enables all "bundles" on startup,
+it may affect startup times though -- but this is of course only
+relevant if you have a lot of plugins installed.
+
+See also http://vim-scripts.org/vim/tools.html for additional information.
+
+
+** Use macros/tplugin.vim
Short version:
1. Save a local copy of the tplugin_vim repository under
- ''~/vimfiles/repos/vimtlib'' (on some systems it's
- ''~/.vim/repos/vimtlib''). Get it from here:
+ ''~/vimfiles/bundles/vimtlib'' (on some systems it's
+ ''~/.vim/bundles/vimtlib''). Get it from here:
http://github.com/tomtom/tplugin_vim
2. Insert the following line rather at the beginning of your
''vimrc'' file:
- ''runtime repos/tplugin_vim/macros/tplugin.vim''.
+ ''runtime bundles/tplugin_vim/macros/tplugin.vim''.
Some plugins in the vimtlib repository require
''plugin/02tlib.vim'' to be loaded first. If you get an error
message telling you that ''tlib'' is required, you can either
tell me about that error or add the following line to the
''vimrc'' file:
- ''TPlugin! vimtlib 02tlib''.
+ ''TPlugin! tlib_vim 02tlib''. This assumes that you saved the
+ tlib library from http://github.com/tomtom/tlib_vim to the
+ ''bundles'' directory from before.
3. Run '':TPluginScan! all'' to enable autoloading.
- 4. Restart vim.
+ 4. Restart vim. VIM should now load stub definitions for all
+ commands defined in plugins under the ../bundels directory.
See doc/tplugin.txt for details.
-** Modify the ''runtimepath''
+** Use Marc Weber's vim-addon-manager
+See https://github.com/MarcWeber/vim-addon-manager for details. You can
+also use the addon manager to download the plugins from github for you.
+
+
+
+** Modify the ''runtimepath'' (e.g. with the pathogen plugin)
Add the path to the local copy to 'runtimepath':
@@ -44,9 +80,8 @@ set runtimepath+={PATH TO YOU LOCAL COPY}/vimtlib
You have the following options to facilitate doing this:
- 1. Plugins like Marc Weber's vim-plugin-manager or Tim Pope's
- pathogen could be of help.
-
+ 1. Plugins like Tim Pope's pathogen could be of help -- see
+ https://github.com/tpope/vim-pathogen for details.
2. If you choose this option, you will by default load all
plugins---even those you don't care about. You can disable
@@ -66,17 +101,11 @@ You have the following options to facilitate doing this:
TLibUse tlib tskeleton viki
- 3. vimtlib includes a script macros/tplugin.vim that help managing
- the runtimepath. This script also allows users to use only
- certain plugins from the vimtlib repository. See above for
- details.
-
-
** Use symbolic links
-You can use the file install_plugin.sh to copy files from a local copy
-of a repository to a master .vim directory. Example:
+EXPERIMENTAL: You can use the file install_plugin.sh to copy files from
+a local copy of a repository to a master .vim directory. Example:
install_plugin.sh --update vimtlib/*_vim
@@ -90,7 +119,8 @@ http://gist.github.com/580276
** Use symbolic links
Symlink the files to your vimfiles directory. You could use tools like
-graft for this.
+graft (http://peters.gormand.com.au/Home/tools/graft/graft-html) for
+this.
@@ -115,4 +145,5 @@ See also:
[C-based program to handle vimballs]]
+
% vi: ft=viki:tw=72:ts=4
View
10 README
@@ -1,9 +1,15 @@
-This repository comprises vim-related ruby-scripts, vimball recipes and some support files related to the vim plugins listed in "plugins.txt".
+This repository used to include several plugins many of which were moved to git repositories of their own -- please see https://github.com/tomtom for a list of plugins. The remaining parts of vimtlib include vim-related ruby-scripts, vimball recipes and other support files related to the vim plugins listed in "plugins.txt".
* Install
-See INSTALL.TXT
+For VIM plugins see INSTALL.TXT.
+
+For vimdedoc.rb: Make sure the ruby script is executeable and put it (or an alias) into a directory that is included in ''$PATH''. On windows, I suggest to create a batch script that includes the line ''ruby.exe %DIRECTORY%\\vimtlib\\ruby\\vimdedoc.rb %*''.
+
+Skeletons: The skeletons have to be copied into ~/.vim/skeletons/... or ~/vimfiles/skeletons/...
+
+Vimball recipes: You can use VIM's ''MkVimball'' command or the ruby-based vimball.rb (https://github.com/tomtom/vimball.rb) to create vimballs from those recipes.
* Scripts
Please sign in to comment.
Something went wrong with that request. Please try again.