[logaling-commit] logaling/logalimacs [master] add document (on the way)

Back to archive index

null+****@clear***** null+****@clear*****
Tue Jan 17 00:34:53 JST 2012


yuta yamada	2012-01-17 00:34:53 +0900 (Tue, 17 Jan 2012)

  New Revision: 03c402c921bfd53d597ceb27464e5599ab8b5d17

  Log:
    add document (on the way)

  Added files:
    docs/GettingStarted.md
    docs/README.md
    docs/WhatsNew.md
    docs/usage.md

  Added: docs/GettingStarted.md (+12 -0) 100644
===================================================================
--- /dev/null
+++ docs/GettingStarted.md    2012-01-17 00:34:53 +0900 (cbb5bcc)
@@ -0,0 +1,12 @@
+# GettingStarted
+## How to install for Emacs24
+
+    M-x list-packages
+    lookup to logalimacs
+    もっとちゃんとかく....
+
+## How to install for otherwise
+
+
+    % git clone https://yuuta****@githu*****/logaling/logalimacs.git
+

  Added: docs/README.md (+13 -0) 100644
===================================================================
--- /dev/null
+++ docs/README.md    2012-01-17 00:34:53 +0900 (3822c4c)
@@ -0,0 +1,13 @@
+# README
+## What's logalimacs?
+logalimacs is front-end program of lagaling-command for Ruby gem.
+もっとちゃんと書く!!
+## Usage
+=> todo link usage.md
+
+## send bug or request
+=> todo create request.md
+
+## How to [_install_](./GettingStarted.md).
+=> todo fix link err and create GettingStarted.md
+## Fork me on [_github_](https://github.com/logaling/logalimacs).

  Added: docs/WhatsNew.md (+3 -0) 100644
===================================================================
--- /dev/null
+++ docs/WhatsNew.md    2012-01-17 00:34:53 +0900 (6b7c1a1)
@@ -0,0 +1,3 @@
+# What's New
+
+

  Added: docs/usage.md (+42 -0) 100644
===================================================================
--- /dev/null
+++ docs/usage.md    2012-01-17 00:34:53 +0900 (11b96e0)
@@ -0,0 +1,42 @@
+# Usage
+1. Put logalimacs where to pass load-path.
+2. Sets as below to your .emacs for setting.
+3. let's type M-x loga-intarective-command or your set key.
+4. if you like type "f" after the intarective-command, allow to executable "loga lookup" at on the fly.  
+(word to point of current cursor where execute the lookup)
+5. retype like same "4.~" section, you can avoid above used loga-fly-mode.
+
+---
+
+    ;;the second section example
+    (when (require 'logalimacs nil t)
+      (global-set-key (kbd "M-g M-i") 'loga-interactive-command)
+      (global-set-key (kbd "M-g M-l") 'loga-lookup-in-hand-or-region)
+      (global-set-key (kbd "M-g M-a") 'loga-add-word))
+
+    ;;or, use only interactive-command
+    (autoload 'loga-interactive-command "logalimacs"
+      "front-end for logaling-command")
+    (global-set-key (kbd "M-g M-i") 'loga-interactive-command)
+
+---
+
+
+# convenient configuration for popwin.el
+
+
+this is requirement [_popwin.el_](http://www.emacswiki.org/emacs/PopWin).
+
+    (require 'popwin)
+    (setq display-buffer-function 'popwin:display-buffer)
+    (setq popwin:special-display-config
+          (append '(
+                ("*logalimacs*" :position bottom :height 10 :noselect t :stick t)
+                ;;if need to other configuration, add for like below:
+                ;("*Backtrace*")
+                )
+              popwin:special-display-config))
+
+    (setq popwin:popup-window-height 15   ;default 15. if left or right, ignored
+          popwin:popup-window-width 30    ;default 30. if top or bottom, ignored
+          )




More information about the logaling-commit mailing list
Back to archive index