diff --git a/Makefile b/Makefile index ec4272b..e9a3d8b 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,6 @@ all: pangu-spacing.elc README.md: make-readme-markdown.el emacs --script $< $@ 2>/dev/null - sed -i '1s%^%Normalize Logo \n%' $@ make-readme-markdown.el: wget -q -O $@ https://raw.github.com/mgalgs/make-readme-markdown/master/make-readme-markdown.el diff --git a/README.md b/README.md index 1f66f68..d64b95a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ -Normalize Logo +Emacs Logo ## pangu-spacing.el *Minor-mode to add space between Chinese and English characters.* --- [![License GPLv3](https://img.shields.io/badge/license-GPL_v3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.html) +[![Build Status](https://travis-ci.org/coldnew/pangu-spacing.svg?branch=master)](https://travis-ci.org/coldnew/pangu-spacing) [![MELPA](http://melpa.org/packages/pangu-spacing-badge.svg)](http://melpa.org/#/pangu-spacing) [![MELPA Stable](http://stable.melpa.org/packages/pangu-spacing-badge.svg)](http://stable.melpa.org/#/pangu-spacing) @@ -115,15 +116,36 @@ this: (take org-mode as example) (set (make-local-variable 'pangu-spacing-real-insert-separtor) t))) -### Function Documentation -#### `(pangu-spacing-search-buffer REGEXP START END FUNC)` +### Customization Documentation + +#### `pangu-spacing-separator` + +String to be display between Chinese and English. + +#### `pangu-spacing-real-insert-separtor` + +Set t or nil to make space show only on overlay or insert in file. +When you set t here, the space will be insert when you save file. + +#### `pangu-spacing-inhibit-mode-alist` + +Inhibit mode alist for pangu-spacing-mode. + +#### `pangu-spacing-special-region-func-alist` + +Alist mapping major-mode to the corresponding function to + check for special region that shall not write real pangu-space + +### Function and Macro Documentation + +#### `(pangu-spacing-search-buffer REGEXP START END FUNC)` (macro) Helper macro to search buffer and do func according regexp for pangu-spacing-mode. -#### `(pangu-spacing-search-overlay BEG END FUNC REGEXP)` +#### `(pangu-spacing-search-overlay BEG END FUNC REGEXP)` (macro) Helper macro to search and update overlay according func and regexp for pangu-sapce-mode. @@ -165,7 +187,7 @@ Delete all pangu-spacing-overlays in BUFFER. Space current buffer. It will really insert separator, no matter what -‘pangu-spacing-real-insert-separtor’ is. +`pangu-spacing-real-insert-separtor` is. -----
diff --git a/pangu-spacing.el b/pangu-spacing.el index 635e7e3..4c7157a 100644 --- a/pangu-spacing.el +++ b/pangu-spacing.el @@ -6,6 +6,7 @@ ;; Kyewords: converience ;; Version: 0.4 ;; X-URL: http://github.com/coldnew/pangu-spacing +;; URL: http://github.com/coldnew/pangu-spacing ;; This file is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by @@ -22,8 +23,6 @@ ;;; Commentary: -;; [![MELPA](http://melpa.org/packages/pangu-spacing-badge.svg)](http://melpa.org/#/pangu-spacing) -;; [![MELPA Stable](http://stable.melpa.org/packages/pangu-spacing-badge.svg)](http://stable.melpa.org/#/pangu-spacing) ;;; Screenshot: ;; ![Screenshot](https://github.com/coldnew/pangu-spacing/raw/master/screenshot/screenshot.gif)