Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Bug fix: Fixed usage instructions to include tags generation :-\

  • Loading branch information...
commit 8eee22a18373125398d853dc3848d4101865576b 1 parent 3211a29
Peter Odding authored June 05, 2010

Showing 1 changed file with 21 additions and 7 deletions. Show diff stats Hide diff stats

  1. 28  README.md
28  README.md
Source Rendered
@@ -18,9 +18,23 @@ wondering what the result looks like, I've published [the plug-in source code]
18 18
 
19 19
 Unzip the most recent [ZIP archive] [zip] file inside your Vim profile
20 20
 directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on
21  
-Windows), restart Vim and try it out. Create a Vim script that calls the
22  
-function `Publish()` as follows:
  21
+Windows). As an example we'll publish the plug-in using itself. First create a
  22
+tags file that contains entries for the files you want to publish using a shell
  23
+command such as:
23 24
 
  25
+    ctags -Rf ~/.publish_tags ~/.vim/
  26
+
  27
+If this doesn't work because `ctags` isn't installed you can download it from
  28
+the [Exuberant Ctags homepage] [ctags], or if you're running Debian/Ubuntu you
  29
+can install it by executing the following shell command:
  30
+
  31
+    sudo apt-get install exuberant-ctags
  32
+
  33
+The plug-in needs an up-to-date tags file so that it create hyperlinks between
  34
+the published files. Now start Vim and write a script that registers the tags
  35
+file you just created and calls the function `Publish()` as follows:
  36
+
  37
+    set tags=~/.publish_tags
24 38
     let sources = '/home/peter/.vim'
25 39
     let target = 'sftp://peterodding.com/code/vim/profile'
26 40
     call Publish(sources, target, [
@@ -30,11 +44,11 @@ function `Publish()` as follows:
30 44
         \ 'plugin/publish.vim',
31 45
         \ ])
32 46
 
33  
-Change the `sources` and `target` variables to reflect your situation, save
34  
-your script as `~/publish_test.vim` and you can execute the script in Vim by
35  
-typing `:source ~/publish_test.vim` and pressing `Enter↵`. If everything goes
36  
-well Vim will be busy for a moment and after that you will find a bunch of
37  
-syntax highlighted, interlinked HTML documents in the `target` directory!
  47
+Change the `sources` and `target` variables to reflect your situation, save the
  48
+script as `~/publish_test.vim` and execute it in Vim by typing `:source
  49
+~/publish_test.vim` and pressing `Enter↵`. If everything goes well Vim will be
  50
+busy for a moment and after that you will find a bunch of syntax highlighted,
  51
+interlinked HTML documents in the `target` directory!
38 52
 
39 53
 ## Contact
40 54
 

0 notes on commit 8eee22a

Please sign in to comment.
Something went wrong with that request. Please try again.