Browse files

init import

  • Loading branch information...
1 parent 04698c1 commit e79a3ecd1d9f8d5b1a8ec551390a50c8ba7fd35e @c9s c9s committed Oct 24, 2009
Showing with 125 additions and 4 deletions.
  1. +122 −2 README
  2. +3 −1 Vim-META.spec
  3. +0 −1 lib/Vim/Packager.pm
View
124 README
@@ -1,11 +1,11 @@
-Vim-Packager
+VIM::PACKAGER TUTORIAL
$ vim-packager create --name=new_plugin --type plugin --author=Cornelius --email=cornelius.howl@DELETE-ME.gmail.com
new_plugin/
new_plugin/plugin/
new_plugin/doc/
- new_plugin/meta
+ new_plugin/META
fill your 'META' file
@@ -18,6 +18,10 @@ Vim-Packager
autocomplpop.vim > 0.3
rainbow.vim >= 1.2
+ =script
+ bin/parser
+ bin/template_generator
+
=repository git://....../
$ vim-package manifest
@@ -30,12 +34,128 @@ Vim-Packager
$ vim-package build
+ $ vim-package dist
+
new_plugin-0.1.tar.gz # is out
$ vim-package upload new_plugin-0.1.tar.gz
Uploading...Done
+you can also define your '.IGNORE' file
+
+ .git*
+ test-
+
+VIM::PACKAGER INSTALLATION
+
+ $ vim-packager build
+
+ # build action
+ read 'meta' file , and convert meta into meta.yml
+ or read 'meta.yml' file
+
+ read 'manifest' file list
+
+ generate Makefile
+
+ $ sudo make install
+
+FOR AN EXISTED VIM DISTRIBUTION
+
+ $ cd my_plugin
+
+ $ ls -1
+
+ after/
+ syntax/
+ plugin/
+ doc/
+ README
+
+ $ vim-packager init
+
+ # which generates
+ META
+ MANIFEST
+ .IGNORE
+
+ # name from parent directory name
+ # version (should try to parse *.vim files)
+ # author (should try to parse *.vim files)
+ # dependency (user should define it by self)
+
+ # your should update your package information from META file
+
+ $ vim-packager build
+
+ $ make install
+
+VIMSCRIPT DOCUMENT FORMAT
+
+
+ BASIC REQUIREMENT:
+
+ "=NAME your name
+ "
+ "=AUTHOR Cornelius
+ "
+ "=AUTHORS
+ " Kana
+ " Cornelius
+ "
+ "=VERSION 0.2
+ "
+ "=DESCRIPTION
+ "
+ " stories....
+ " more ...
+ "
+ "=LICENSE MIT
+ "
+ "=REPOSITORY http://github.com/c9s/p5-vim-packager
+ "
+ "=REVISION r4356
+ "
+ "=REVISION da743bd63d7afa1cc8e054615c0208c1a871b0e2
+
+ VARIABLE DOC FORMAT:
+
+ "=g:Var
+ "
+ " g:somehting
+ " variable description
+ " g:options
+ " variable description
+ " line2
+ " g:options
+ "
+ "==
+
+ "=s:Var
+ "
+ " s:somehting
+ " variable description
+ " s:options
+ " variable description
+ " line2
+ " s:options
+ "
+ "==
+
+ FUNCTION DOC FORMAT:
+
+ "=FUNC
+ "=FUNCTION
+ " function_name :
+ " list@hash :
+ " description
+ "
+ " name@string :
+ " description
+ "
+ " @return:
+ "==
INSTALLATION
View
4 Vim-META.spec
@@ -1,4 +1,7 @@
+
+'META' file
+
=author Cornelius (cornelius.howl@gmail.com)
=version 0.1
=version plugin/new_plugin.vim
@@ -11,4 +14,3 @@
svn: http://...../
svn: svn+ssh://..../..../
darcs: .....
-
View
1 lib/Vim/Packager.pm
@@ -20,7 +20,6 @@ our $VERSION = '0.01';
use Vim::Packager;
my $packager = VIM::Packager->create(
- name => '',
);

0 comments on commit e79a3ec

Please sign in to comment.