wosmvp-yac 0.1.6 → 1.0.0

data/README.rdoc

@@ -1,47 +1,86 @@
 =  YAC => Yet Another Cheet (Powered By Ruby)
+  YAC was inspired by 'chit' (http://github.com/robin/chit) by robin and 'cheat' (http://cheat.errtheblog.com/) by Chris Wanstrath,But @@@Colorful and Sexy!!!@@@
 
-== FEATURES:
-  YAC was inspired by 'chit' (http://github.com/robin/chit) by robin and 'cheat' (http://cheat.errtheblog.com/) by Chris Wanstrath
-  what's the different:
-  @@@Colorful and Sexy!@@@
+== What?
+  Cheat sheet is a concise set of notes used for quick reference.
+  YAC is a simple sexy command line tool for easy control cheatsheet.(Images can be found here: http://picasaweb.google.com/wosmvp/YacYetAnotherCheat)
+  Yes,It's support Image,PDF,Text, and can be easily enhance :)
+  Install, Use, Enjoy :)
+
+== Install
+   Make sure you have ruby,git in your system . then:
+   $ (sudo) gem install yac -s http://gems.github.com
 
 == How To Use
 
 === To initialize repositories:
-    $ yac init
-=== To get a cheat sheet:
-    $ yac [cheatsheet]
+    When you run any command,The repositories will be initialize automatically.
+
+=== To show a cheat sheet:
+    $ yac (show) [cheatsheet] ( you can use * for any chars)
+    Eg:
+    $ yac show lin*x
+
 === To edit a cheat sheet
-    $ yac edit [cheatsheet]
+    $ yac edit [cheatsheet] (Yes,you can use * for any chars also,then choose one to edit)
+
 === To add a cheat sheet
-    $ yac add [cheatsheet]
+    $ yac add [cheatsheet] (OMG,you can also use *)
+    Eg:
+    $ yac li*x/install
+    Then will display all directories match /li*x/,feel freely to choose one of them,
+    A new file named install.ch will be added to the directory!
+
 === To rm a cheat sheet
-    $ yac rm [cheatsheet]
-=== Search according the sheets name
-    $ yac name [keyword]
-=== Search according the sheets content
-    $ yac content [keyword]
+    $ yac rm [cheatsheet] (Sure,you can use *)
+
+=== Search all sheets
+    $ yac search [keyword] (@@@Take Attention:@@@ You are allowed to use perl-like Regex)
+    Eg:
+    $ yac search lin.*x
+    And Even:
+    $ yac search "r(uby|ails)"
+
 === Update repositories
     $ yac update main  => Update main repository
-    $ yac update private => Update private repository
-    $ yac update => Update All
-=== Help
-    $ yac help / yac / -h / --help
+    $ yac update all => Update all repositories
+    $ yac update => Update private repository
+
 === Shell
-    $ yac shell / sh main => Open the main repository's shell
-    $ yac shell / sh => Open the private repository's shell
+    $ yac sh main => Open the main repository's shell
+    $ yac sh => Open the private repository's shell
+
+== Repository Push
+    $ yac push main => Push the main repository
+    $ yac push all => Push all repositories
+    $ yac push => Push the private repository
+
+== Rename a cheatsheet:
+    $ yac mv [orign_name] [new_name]
+
+=== Help (display this file)
+    $ yac help
+
+=== Version
+    $ yac -v | version
+
 === Documents format
-   Use .ch as the suffix ,At the beginning of the row,plus N = for the N-class title
-   Use '#' at the beginning of a row to comment the line,You can use '\#' to get '#'
-   Use three @ wrap some words to highlight it,for example: @@\@ HI @@\@ (remove the \) will highlight HI
-=== Set the color of highlight
-   Default use .yacrc under home directory to set,, details, see the example file under the resources directory
+   All text file add ".ch" as suffix for butter editor highlight
+   (A very very simple vim script can be found here : http://www.vim.org/scripts/script.php?script_id=2399)
+
+   At the beginning of the row,plus N = for the N-class title
+
+   Use '#' at the beginning of a row to comment the line,You can use '\#' for '#'
+
+   Words wrapped by three @ for highlight
+
+=== The configure file
+   Default use $HOME/.yacrc , See the example file under resources directory
+
 === Others
-   Add @ before [cheatsheet]/[keyword] will only search the main depot
-   See also the source code to get more sexy ways
+   Add @ before [keyword] will only affect the main repository
 
 == REQUIREMENTS:
-
 * Ruby
 * rubygems
 * git

data/lib/format.rb

@@ -1,19 +1,22 @@
 module Format
-  Pdf_Error = "Please Modify ~/.yacrc To Provide A Valid Command To Open PDF Document"
-  Image_Error = "Please Modify ~/.yacrc To Provide A Valid Command To Open Image Document"
+  Pdf_Error = "Please Modify ~/.yacrc To Provide A Valid Command To Operate PDF Document"
+  Image_Error = "Please Modify ~/.yacrc To Provide A Valid Command To Operate Image Document"
+  Doc_Error = "Please Modify ~/.yacrc To Provide A Valid Command To Operate Text Document"
 
   def format_file(file)
     @level = 0
-    case `file #{file}`
-    when / PDF /
-      puts Pdf_Error unless system("#{Yac::CONFIG["pdf_command"]||'evince'} #{file}")
+    colorful(file,"filename") if file
+    case `file "#{file}" 2>/dev/null`
+    when / PDF document/
+      puts Pdf_Error unless system("#{Yac::CONFIG["pdf_command"]||'evince'} \"#{file}\" 2>/dev/null")
     when /( image )|(\.svg)/
-      puts Image_Error unless system("#{Yac::CONFIG["pic_command"]||'eog'} #{file}")
+      puts Image_Error unless system("#{Yac::CONFIG["image_command"]||'eog'} \"#{file}\" 2>/dev/null")
     else
       File.new(file).each do |x|
         format_section(x)
       end
     end
+  rescue
   end
 
   def format_section(section,search = false)
@@ -22,17 +25,30 @@ module Format
       @level = search ? 1 : $1.size
       colorful("\s"*2*(@level-1) + $2,"head#{@level}")
     when /^(\s*)#/
+      colorful(section.sub(/^\s*/,'')) if search
+    else
+      colorful(section.sub(/^\#/,"#").sub(/^\s*/, "\s" * ( @level||0 ) * 2 ))
+    end
+  end
+
+  def edit_file(file)
+    case `file "#{file}" 2>/dev/null`
+    when / PDF /
+      puts Pdf_Error unless system("#{Yac::CONFIG["pdf_edit_command"]||'ooffice'} \"#{file}\" 2>/dev/null")
+    when /( image )|(\.svg)/
+      puts Image_Error unless system("#{Yac::CONFIG["image_edit_command"]||'gimp'} \"#{file}\" 2>/dev/null")
     else
-      colorful(section.sub(/^\#/,"#").sub(/^\s*/, "\s" * @level * 2 ))
+      edit_text(file)
     end
   end
 
-  def editor
-    Yac::CONFIG["editor"] || ENV['EDITOR'] || "vim"
+  def edit_text(file)
+    prepare_dir(file)
+    puts Doc_Error unless system("#{Yac::CONFIG["editor"] || ENV['EDITOR'] ||'vim'} \"#{file}\" 2>/dev/null")
   end
 
-  def title_of_file(f)
-    f[0..((f.rindex('.')||0) - 1)]
+  def clean_filename(f)
+    return f.sub(/^(.*)?(main|private)\/(.*)/,'\3').sub(/^@/,'')
   end
 
   def colorful(stuff,level="text",line_break = true)
@@ -42,15 +58,13 @@ module Format
   end
 
   def empha(stuff,level="text",empha_regexp=/(@@@(.*)@@@)/)
-    stuff.scan(empha_regexp) do |x|
+    stuff.to_s.scan(empha_regexp) do |x|
       return stuff.gsub(x[0],"\033[0m\033[#{Yac::CONFIG["empha"].to_s}m%s\033[0m\033[%sm" % [x[1],Yac::CONFIG[level]])
     end
   end
 
-  def show_possible_result
-    unless @all_result.to_s.empty?
-      colorful("ALL POSSIBLE RESULT:","possible_result_title")
-      colorful(@all_result.join("\s"*2),"possible_result_content")
-    end
+  def prepare_dir(file)
+    dirseparator = file.rindex(File::Separator)+1
+    FileUtils.mkdir_p(file[0,dirseparator])
   end
 end

data/lib/yac.rb

@@ -6,8 +6,11 @@ module  Yac
   extend self
 
   YACRC = File.join("#{ENV['HOME']}",".yacrc")
+
   FileUtils.cp(File.join(File.dirname(__FILE__), "..","resources","yacrc"), YACRC) unless File.exist?(YACRC)
+
   CONFIG = YAML.load_file(File.join(ENV['HOME'],".yacrc"))
+
   CONFIG["root"] ||= File.join(ENV['HOME'],".yac")
 
   @main_path, @pri_path = File.join(CONFIG["root"],"/main/"), File.join(CONFIG["root"],"/private/")
@@ -15,41 +18,39 @@ module  Yac
   @pri_git = Git.open(@pri_path)if File.exist?(@pri_path)
 
   def new(args)
-    unless File.exist?(@main_path) && File.exist?(@pri_path)
-      return unless init
-    end
-    @all_result = []
+    init unless File.exist?(@main_path) && File.exist?(@pri_path)
     (help && exit) if args.empty?
     case args.first
     when "show" then show(args[1,args.size])
-    when "name" then search(args[1,args.size],"name")
-    when "content" then search(args[1,args.size],"content")
+    when "search" then search(args[1,args.size])
     when "update" then update(args[1,args.size])
-    when /^(add|edit)$/ then edit(args[1,args.size])
+    when "push" then push(args[1,args.size])
+    when "add" then add(args[1,args.size])
+    when "edit" then edit(args[1,args.size])
     when /^(help|-h|yac|--help)$/ then help
-    when /^(sh|shell)$/ then shell(args[1,args.size])
+    when "sh" then shell(args[1,args.size])
     when "rm" then rm(args[1,args.size])
-    when "init" then init
+    when "mv" then rename(args[1,args.size])
+    when /^version|-v$/ then
+      load File.join(File.dirname(__FILE__), "..", "yac.gemspec");colorful("yac, version: " + VER,"notice")
     else show(args)
     end
-    show_possible_result
   rescue
   end
 
   def init
     FileUtils.mkdir_p(CONFIG['root'])
     {"main" => @main_path,"private" => @pri_path}.each do |name,path|
-      unless File.exist?(path)
+      if File.exist?(path)
+        colorful("#{name} repository has already initialized.","notice")
+      else
         if CONFIG["#{name}"] && CONFIG["#{name}"]['clone-from']
-          puts "Initialize #{name} repository from #{CONFIG[name]['clone-from']} to #{CONFIG['root']}/#{name}"
+          colorful("Initialize #{name} repository from #{CONFIG[name]['clone-from']} to #{CONFIG['root']}/#{name}","notice")
           Git.clone(CONFIG["#{name}"]['clone-from'], name, :path => CONFIG['root'])
         else
-          puts "Initialize #{name} repository from scratch to #{CONFIG['root']}/#{name}"
-          git = Git.init(path)
-          git.add
-          git.commit_all("init #{name} repository")
+          colorful("Initialize #{name} repository from scratch to #{CONFIG['root']}/#{name}","notice")
+          Git.init(path)
         end
-        puts "#{name} repository initialized."
         @main_git = Git.open(@main_path) if File.exist?(@main_path)
         @pri_git = Git.open(@pri_path)if File.exist?(@pri_path)
       end
@@ -60,25 +61,40 @@ module  Yac
     args.each {|x| show_single(x)}
   end
 
-  def search(args,type = "name")
-    args.each {|x| search_single(x,type)}
+  def search(args)
+    args.each {|x| search_content(x)}
   end
 
   def update(args)
-    unless args.empty?
-      @pri_git.pull if args.to_s =~ /pri/
-        @main_git.pull if args.to_s =~ /main/
-    else
-      @main_git.pull && @pri_git.pull
+    case args.to_s
+    when /main/ then result = `cd "#{@main_path}" && git pull `  #NOTE There is an bug in the git.gem,Then I will write a new git library use shell command
+    when /all/  then result = `cd "#{@pri_path}" && git pull && cd "#{@main_path}" && git pull `
+    else result = `cd "#{@pri_path}" && git pull`
     end
+    colorful(result,"notice")
   rescue
-    puts "ERROR: can not update the repository,\n #{$!}"
+    colorful("ERROR: can not update the repository,\n\n#{$!}","warn")
+  end
+
+  def push(args)
+    case args.to_s
+    when /main/ then result=@main_git.push
+    when /all/  then result=@pri_git.push && result << @main_git.push
+    else result = @pri_git.push
+    end
+    colorful(result,"notice")
+  rescue
+    colorful("Usage:\nyac push ( main | all )\n\nTry `yac -h` for more help\n\n#{$1}","warn")
   end
 
   def edit(args)
     args.each {|x| edit_single(x)}
   end
 
+  def add(args)
+    args.each {|x| add_single(x)}
+  end
+
   def rm(args)
     args.each {|x| rm_single(x)}
   end
@@ -90,97 +106,146 @@ module  Yac
   def shell(args)
     case args.to_s
     when /main/
-      colorful(" Welcome To The Main Yac Repository","head1")
-      system "cd #{@main_path}; sh"
+      colorful(" Welcome To The Main Yac Repository","notice")
+      system "cd \"#{@main_path}\"; sh"
     else
-      colorful(" Welcome To The Private Yac Repository","head1")
-      system "cd #{@pri_path}; sh"
+      colorful(" Welcome To The Private Yac Repository","notice")
+      system "cd \"#{@pri_path}\"; sh"
     end
   end
 
-  protected
-  def rm_single(args)
-    full_path(args)
-    begin
-      @working_git.remove(@file_path)
-      @working_git.commit_all("#{args.sub(/^@/,"")}.ch removed")
-    rescue Git::GitExecuteError
-      FileUtils.rm_rf(@file_path)
+  def rename(args)
+    (colorful("Usage:\nyac mv [orign_name] [new_name]\n\nTry `yac -h` for more help","warn");exit) unless args.size == 2
+    file = search_name(args[0],"Rename")
+    new_name = file.sub(/^((?:.*)?(?:main|private)\/)(.*)(\..*)/,'\1'+args[1]+'\3')
+    if confirm("You Are Renaming #{file} To #{new_name}")
+      `mv "#{file}" "#{new_name}"`
+      @working_git.add
+      @working_git.commit_all("#{clean_filename(file)} Renamed to #{clean_filename(new_name)}")
     end
   end
 
-  def edit_single(args)
-    full_path(args)
-    prepare_dir
-    system("#{editor} #{@file_path}")
-    @working_git.add
-    @working_git.commit_all(" #{args.sub(/^@/,"")}.ch Updated")
+  protected
+  def add_single(args)
+    if args.include?('/') && args =~ /(@?)(?:(.*)\/)(.+)/
+      path = $1.empty? ? @pri_path : @main_path
+      all_path = %x{
+        find #{path} -type d -iwholename '#{path}*#{$2}*' -not -iwholename '*.git*'| sed 's/^.*\\(private\\|main\\)\\//#{$1}/'
+      }.to_a
+      colorful("Which directory do you want to use:","notice")
+      choosed_path = choose_one(all_path.concat([$1+$2]).uniq)
+      args = choosed_path + "/" + $3 if choosed_path
+    end
+    file = full_path(args+".ch")
+    if confirm("You Are Adding #{file}")
+      edit_text(file)
+      @working_git.add
+      @working_git.commit_all("#{clean_filename(file)} Added")
+    end
   end
 
   def show_single(args)
-    result = search_single(args)
-    if result.size == 1
-      colorful(result.first,"filename")
-      format_file(result.first)
-    else
-      result.map do |x|
-        if x =~ /\/#{args.sub(/^@/,"")}\.\w+/
-          colorful(x,"filename")
-          format_file(x)
-        end
-      end
-    end
+    file = search_name(args,"Show")
+    format_file(file)
   end
 
-  def search_single(args,type="name")
-    if type =~ /name/
-      search_name(args)
-    else
-      search_content(args)
+  def rm_single(args)
+    file = search_name(args,"Remove")
+    if confirm("You Are Removing #{file}.")
+      begin
+        @working_git.remove(file)
+        @working_git.commit_all("#{clean_filename(file)} Removed")
+      rescue Git::GitExecuteError
+        FileUtils.rm_rf(file)
+      end
     end
   end
 
-  def search_name(args)
-    if args =~ /^@/ && main = args.sub(/^@/,"")
-      @private_result = []
-      @main_result = @main_git.ls_files.keys.grep(/#{main}/)
-    else
-      @private_result = @pri_git.ls_files.keys.grep(/#{args}/)
-        @main_result = @main_git.ls_files.keys.grep(/#{args}/)
-    end
-    @all_result << @main_result.collect {|x| "@" + x} << @private_result
+  def edit_single(args)
+    file = search_name(args,"Edit")
+    edit_file(file)
+    @working_git.add
+    @working_git.commit_all("#{clean_filename(file)} Updated")
+  end
 
-    @private_result.map do |x|
-      @main_result.delete(x)
+  def search_name(args,msg = nil)
+    path = (args =~ /^(@)/) ? [@main_path] : [@main_path , @pri_path]
+    result = []
+    path.each do |x|
+      result.concat(`find "#{x}" -type f -iwholename '#{x}*#{args.sub(/^@/,'').strip}*' -not -iwholename '*.git*'| sed 's/^.*\\(private\\|main\\)\\//#{x=~/main/ ? '@':'' }/'`.to_a)
     end
-    return (@main_result.collect {|x| @main_path +x}).concat(@private_result.collect {|x| @pri_path +x})
+    return result.empty? ? (colorful("Nothing Found About < #{args} >","warn")) :
+      (colorful("The Results About < #{args} > To #{msg || "Operate"} :","notice");full_path(choose_one(result)))
   end
 
   def search_content(args)
-    result = `cd #{@pri_path} && grep -n #{args} -R *.ch 2>/dev/null`
-    result << `cd #{@main_path} && grep -n #{args} -R *.ch 2>/dev/null | sed 's/^/@/g'`
+    args.sub!(/^"(.*)"/,'\1')
+    result = `cd "#{@pri_path}" && grep -n -i -P '#{args}' -R *.ch 2>/dev/null`.to_a
+    result.concat(`cd "#{@main_path}" && grep -n -i -P '#{args}' -R *.ch 2>/dev/null | sed 's/^/@/g'`.to_a)
+    all_result = []
     result.each do |x|
       stuff = x.split(':',3)
-      colorful(title_of_file(stuff[0]),"filename",false)
+      colorful(stuff[0],"filename",false)
       print " "
       colorful(stuff[1],"line_number",false)
       print " "
-      format_section(empha(stuff[2],nil,/((#{args}))/),true)
+      format_section(empha(stuff[2],nil,/((#{args}))/i),true)
+      all_result.concat(stuff[0].to_a)
+    end
+    loop do
+      colorful("All files Contain #{args.strip},Choose one to show","notice")
+      file =  full_path(choose_one(all_result))
+      file ? format_file(file) : exit
     end
-  end
-
-  def prepare_dir
-    dirseparator = @file_path.rindex(File::Separator)+1
-    FileUtils.mkdir_p(@file_path[0,dirseparator])
   end
 
   def full_path(args)
+    return false unless args
     if args =~ /^@/
-      @file_path = @main_path + args.sub(/^@/,"") + ".ch"
       @working_git = @main_git
+      file = @main_path + args.sub(/^@/,"")
     else
-      @file_path = @pri_path + args + ".ch"
       @working_git = @pri_git
+      file = @pri_path + args
+    end
+    return file.strip
+  end
+
+  def confirm(*msg)
+    colorful("#{msg.to_s}\nAre You Sure (Y/N) (q to quit):","notice",false)
+    case STDIN.gets
+    when /n|q/i
+      return false
+    when /y/i
+      return true
+    else
+      colorful("Please Input A Valid String,","warn")
+      confirm(msg)
     end
   end
+
+  # Choose one file to operate
+  def choose_one(stuff)
+    if stuff.size == 1
+      return stuff[0]
+    elsif stuff.size > 1
+      stuff.each_index do |x|
+        colorful("%2s" % (x+1).to_s,"line_number",false)
+        printf " %-20s \t" % [stuff[x].rstrip]
+        print "\n" if (x+1)%4 == 0
+      end
+      printf "\n"
+      num = choose_range(stuff.size)
+      return stuff[num-1].to_s.strip
+    end
+  rescue #Rescue for user input q to quit
+  end
+
+  #choose a valid range
+  def choose_range(size)
+    colorful("Please Input A Valid Number To Choose (1..#{size}) (q to quit): ","notice",false)
+    num = STDIN.gets
+    return if num =~ /q/i
+    (1..size).member?(num.to_i) ? (return num.to_i) : choose_range(size)
+  end
 end

data/resources/yacrc

@@ -4,12 +4,14 @@ main:
   clone-from: git://github.com/wosmvp/cheat.git
 #  push-to:
 private:
-#   clone-from:
-#   push-to:
+#  clone-from:
+#  push-to:
 
-#pdf_command: evince
-#pic_command: evince
+pdf_command: evince
+#image_command: eog
 #editor: vim
+#pdf_edit_command: ooffice
+#image_edit_command: gimp
 
 #Set Color
 #1   -   Change text to hicolor (bold) mode
@@ -35,17 +37,17 @@ private:
 #0   -   Turn off all attributes.
 #7   -   Change to Black text on a White background
 
-head1: 31
-head2: 32
-head3: 33
-head4: 34
-head5: 0;31;40
-head6: 0;31;40
-head7: 0;31;40
+head1: 1;31
+head2: 1;36
+head3: 1;33
+head4: 1;32
+head5: 1;34
+head6: 1;35
+head7: 1;37
 
-empha: 32;40
-possible_result_title: 33;41
-possible_result_content: 31
-filename: 31
+warn: 31
+notice: 33
+empha: 31;43
+filename: 34
 line_number: 32
 text:

data/yac.gemspec

@@ -1,10 +1,10 @@
 GEM = "yac"
-VER = "0.1.6"
-DATE = %q{2008-10-18}
+VER = "1.0.0"
+DATE = %q{2008-10-28}
 AUTHOR = "Jinzhu Zhang"
 EMAIL = "wosmvp@gmail.com"
 HOMEPAGE = "http://www.zhangjinzhu.com"
-SUMMARY = "Yet Another Cheat"
+SUMMARY = "Yet Another Cheat: sexy command line tool for cheat sheet"
  
 Gem::Specification.new do |s|
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.autorequire = 'yac'
   s.executables = ["yac"]
  
-  s.files = %w[README.rdoc README.cn yac.gemspec resources/yacrc bin/yac lib/yac.rb lib/format.rb]
+  s.files = %w[README.rdoc yac.gemspec resources/yacrc bin/yac lib/yac.rb lib/format.rb]
 
   #s.has_rdoc = true
   s.rdoc_options = ["--quiet", "--title", "YAC => Yet Another Cheat", "--opname", "index.html", "--line-numbers", "--main", "README.rdoc", "--inline-source"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wosmvp-yac
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jinzhu Zhang
@@ -9,7 +9,7 @@ autorequire: yac
 bindir: bin
 cert_chain: []
 
-date: 2008-10-18 00:00:00 -07:00
+date: 2008-10-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.0
     version: 
-description: Yet Another Cheat
+description: "Yet Another Cheat: sexy command line tool for cheat sheet"
 email: wosmvp@gmail.com
 executables: 
 - yac
@@ -31,7 +31,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - README.rdoc
-- README.cn
 - yac.gemspec
 - resources/yacrc
 - bin/yac
@@ -70,6 +69,6 @@ rubyforge_project: yac
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Yet Another Cheat
+summary: "Yet Another Cheat: sexy command line tool for cheat sheet"
 test_files: []
 

data/README.cn

@@ -1,57 +0,0 @@
-=  YAC => Yet Another Cheet (Powered By Ruby)
-
-== FEATURES:
-  YAC was inspired by 'chit' (http://github.com/robin/chit) by robin and 'cheat' (http://cheat.errtheblog.com/) by Chris Wanstrath
-  what's the different:
-  @@@Colorful and Sexy!@@@
-
-== How To Use
-
-=== 初始化一个仓库:
-    $ yac init
-=== 得到cheat表:
-    $ yac [cheatsheet]
-=== 修改一个cheat表
-    $ yac edit [cheatsheet]
-=== 加入一个cheat表
-    $ yac add [cheatsheet]
-=== 删除一个cheat表
-    $ yac rm [cheatsheet]
-=== 按照cheat表的文件名搜索
-    $ yac name [keyword]
-=== 按照cheat表的内容搜索
-    $ yac content [keyword]
-=== 更新git仓库
-    $ yac update main 更新主仓库
-    $ yac update private 更新个人仓库
-    $ yac update 全部更新
-=== 帮助
-    $ yac help / -h /--help / yac
-=== 打开仓库shell
-    $ yac shell / sh main 打开主仓库的shell
-    $ yac shell / sh 打开个人仓库的shell
-=== 文档格式
-   使用.ch后缀,在行首加一个=为一级标题，加N个=为N级标题,不同级别标题可以加入不同颜色高亮
-   在行首加入#将忽略该行,使用 '\#'可以得到 '#'的效果
-   在某词两端加入三个@，例:@@\@ HI @@\@(去掉两个/)将会高亮 HI
-=== 设置高亮的颜色
-   默认用主目录下的 .yacrc来设置，详细内容，参见 resources目录 yacrc文件
-=== 其它
-   在 表名/关键词 前加入@将会只搜索主仓库
-   更多性感使用方法,参见源码 :)
-
-== REQUIREMENTS:
-
-* Ruby
-* rubygems
-* git
-
-== LICENSE:
-
-This software is shared by GPL3 License
-
-Copyright (c) 2008 Jinzhu Zhang
-
-== BY: Jinzhu Zhang
-http://www.zhangjinzhu.com
-wosmvp (no-spam) gmail (no-spam) com