Commit 84e466e7 authored by Yuanle Song's avatar Yuanle Song

add github issue templates;

- add bug report link in README;
- add melpa badge in README;
- update intro doc in zero-input.el.in, this is used as melpa pkg
  description.
parent b77db074
---
name: Bug report
about: Problems or errors you found while using zero-el
title: ''
labels: bug
assignees: ''
---
**What is the problem and how to reproduce it?**
Please describe how you press keys, what you expect to see, and what you did
see.
**Tell me about your user environment, please fill in versions**
- OS (e.g. Debian 9, Ubuntu 19.04):
- emacs:
M-x emacs-version
- zero-input:
C-h v zero-input-version
- zero-pinyin-service:
apt-cache policy zero-pinyin-service
- zero-panel:
apt-cache policy zero-panel
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---
**Describe the feature you need.**
It is best your feature is concrete and is described in detail.
**Is this feature available in other input methods? If so, please name the other input methods.**
**If you have a patch available, please specify the patch/branch URL.**
......@@ -4,13 +4,16 @@ Time-stamp: <2020-02-20>
* zero-el
[[http://www.melpa.org/#/zero-input][file:http://www.melpa.org/packages/zero-input-badge.svg]]
[[https://stable.melpa.org/#/zero-input][file:https://stable.melpa.org/packages/zero-input-badge.svg]]
zero-el provides zero-input-pinyin, an Emacs pinyin input method for Chinese
and zero-input-framework, which is an emacs Chinese input method framework.
* An introduction to zero-el, including how to install and config zero-el.
https://blog.emacsos.com/zero-el.html
For normal configurable variables, see
For user configurable variables, see
M-x customize-group zero-input
M-x customize-group zero-input-pinyin
......@@ -27,7 +30,7 @@ M-x customize-group zero-input-pinyin
key.
Some notes on pinyin string,
- There is no ü on US keyboard, type v instead. For example lve 略.
- There is no ü on US keyboard, type v instead. For example lv 绿.
- Use ' to separate pinyin substring like xi'an 西安
* Zero Framework features
......@@ -40,6 +43,11 @@ M-x customize-group zero-input-pinyin
"3." will insert "3。", just continue type 6, it will be converted to
"3.6". Same thing for "H。265" -> "H.265".
* Bug Report and Feature Request
Please report bugs at [[https://github.com/sylecn/zero-el/issues][github issues]]. Note that development (and melpa pkg)
still happens on gitlab repo. The github repo is an official mirror to make
reporting issue easier.
* Changelog
- see ./ChangeLog
- The change log include change log from all sub projects.
......
......@@ -114,6 +114,13 @@ cd ~/lisp/elisp/zero/
* later :entry:
* current :entry:
**
** 2020-02-20 add github issue system support.
- create issue templates online. then merge into master.
git remote add github [email protected]:sylecn/zero-el.git
git fetch github sylecn-patch-1
gco github/sylecn-patch-1 .github/
- update README, add bug report doc.
-
** 2019-10-23 checkdoc and package-lint can't ignore some non-issues.
I can't run them in git pre-commit hook.
* done :entry:
......
......@@ -18,10 +18,6 @@
;;; Commentary:
;; zero-input.el is auto-generated from multiple other files. see
;; zero-input.el.in and build.py for details. It's created because
;; package-lint doesn't support multi-file package yet (issue #111).
;;
;; zero-input is a Chinese input method framework for Emacs, implemented as an
;; Emacs minor mode.
;;
......@@ -29,11 +25,13 @@
;; ~/.emacs file:
;;
;; (require 'zero-input)
;; (zero-input-set-default-im 'pinyin)
;; (zero-input-set-default-im "pinyin")
;; ;; Now you may bind a key to zero-input-mode to make it easy to
;; ;; switch on/off the input method.
;; (global-set-key (kbd "<f5>") 'zero-input-mode)
;;
;; Now in any emacs buffer, you may press F5 and start typing pinyin string.
;;
;; zero-input supports Chinese punctuation mapping. There are three modes,
;; none, basic, and full. The default is basic mode, which only map most
;; essential punctuations. You can cycle zero-punctuation-level in current
......@@ -47,6 +45,13 @@
;;
;; (setq-default zero-input-full-width-p t)
;;
;; For other features, you may check README file at
;; https://gitlab.emacsos.com/sylecn/zero-el/
;;
;; zero-input.el is auto-generated from multiple other files. see
;; zero-input.el.in and build.py for details. It's created because
;; package-lint doesn't support multi-file package yet. See issue #111 at
;; https://github.com/purcell/package-lint/issues/111
;;; Code:
......
......@@ -18,10 +18,6 @@
;;; Commentary:
;; zero-input.el is auto-generated from multiple other files. see
;; zero-input.el.in and build.py for details. It's created because
;; package-lint doesn't support multi-file package yet (issue #111).
;;
;; zero-input is a Chinese input method framework for Emacs, implemented as an
;; Emacs minor mode.
;;
......@@ -29,11 +25,13 @@
;; ~/.emacs file:
;;
;; (require 'zero-input)
;; (zero-input-set-default-im 'pinyin)
;; (zero-input-set-default-im "pinyin")
;; ;; Now you may bind a key to zero-input-mode to make it easy to
;; ;; switch on/off the input method.
;; (global-set-key (kbd "<f5>") 'zero-input-mode)
;;
;; Now in any emacs buffer, you may press F5 and start typing pinyin string.
;;
;; zero-input supports Chinese punctuation mapping. There are three modes,
;; none, basic, and full. The default is basic mode, which only map most
;; essential punctuations. You can cycle zero-punctuation-level in current
......@@ -47,6 +45,13 @@
;;
;; (setq-default zero-input-full-width-p t)
;;
;; For other features, you may check README file at
;; https://gitlab.emacsos.com/sylecn/zero-el/
;;
;; zero-input.el is auto-generated from multiple other files. see
;; zero-input.el.in and build.py for details. It's created because
;; package-lint doesn't support multi-file package yet. See issue #111 at
;; https://github.com/purcell/package-lint/issues/111
;;; Code:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment