Added readme.txt
This commit is contained in:
parent
b25edc0a0f
commit
045f1e3b6c
56
README.txt
Normal file
56
README.txt
Normal file
@ -0,0 +1,56 @@
|
|||||||
|
You can use this plugin's basic functionality to set up a list of
|
||||||
|
frequently-accessed files for easy navigation. The list of files
|
||||||
|
will be displayed in a window on the left side of the Vim
|
||||||
|
window, and you can press <Return> or double-click on
|
||||||
|
filenames in the list to open the files. This is similar to how
|
||||||
|
some IDEs I've used work. I find this easier to use than
|
||||||
|
having to navigate a directory hierarchy with the file-explorer.
|
||||||
|
It also obviates the need for a buffer explorer because you
|
||||||
|
have your list of files on the left of the Vim Window.
|
||||||
|
|
||||||
|
|
||||||
|
But there's much, much more . . . .
|
||||||
|
|
||||||
|
You can also instruct the Plugin to change to a directory and
|
||||||
|
to run scripts when you select a file. These scripts can, for
|
||||||
|
example, modify the environment to include compilers in
|
||||||
|
$PATH. This makes it very easy to use quickfix with multiple
|
||||||
|
projects that use different environments. I give examples in
|
||||||
|
the documentation.
|
||||||
|
|
||||||
|
Other features include:
|
||||||
|
o Loading/Unloading all the files in a Project (\l, \L, \w, and \W)
|
||||||
|
o Grepping all the files in a Project (\g and \G)
|
||||||
|
o Running a user-specified script on a file (can be used
|
||||||
|
to launch an external program on the file) (\1 through \9)
|
||||||
|
o Running a user-specified script on all the files in a Project
|
||||||
|
(\f1-\f9 and \F1-\F9)
|
||||||
|
o Also works with the netrw plugin using directory
|
||||||
|
names like ftp://remotehost
|
||||||
|
(Good for webpage maintenance.)
|
||||||
|
o Support for custom mappings for version control
|
||||||
|
integration (example of perforce in the documentation).
|
||||||
|
o I also give an example in the documentation on how to
|
||||||
|
set up a custom launcher based on extension. The
|
||||||
|
example launches *.jpg files in a viewer. I have also set
|
||||||
|
up viewers for PDF (acroread) and HTML files (mozilla)
|
||||||
|
for my own use.
|
||||||
|
|
||||||
|
This plugin is known to work on Linux, Solaris, and Windows.
|
||||||
|
I cannot test it on Windows, though, so please let me know if
|
||||||
|
you run into any problems. If you use it on other platforms,
|
||||||
|
let me know.
|
||||||
|
|
||||||
|
(Let me know if you need a .zip file)
|
||||||
|
|
||||||
|
install details
|
||||||
|
Decompress and untar in your ~/.vim directory (or
|
||||||
|
equivalent). Inside Vim, enter this:
|
||||||
|
:helptags ~/.vim/doc
|
||||||
|
(or equivalent directory)
|
||||||
|
(Enter ":help add-global-plugin" to determine the directory to
|
||||||
|
untar it into.)
|
||||||
|
|
||||||
|
Then enter
|
||||||
|
:help project
|
||||||
|
for information
|
Loading…
Reference in New Issue
Block a user