Skip to content

Commit 167b357

Browse files
authored
Merge pull request #607 from emacs-php/update-readme
Update readme
2 parents bca4c77 + 2bd3ced commit 167b357

File tree

6 files changed

+217
-270
lines changed

6 files changed

+217
-270
lines changed

AUTHORS.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Authors
2+
3+
## Author
4+
5+
- [Turadg Aleahmad](https://github.com/turadg) (Original Author)
6+
- [Daniel Hackney](https://github.com/haxney) (Integrated with CC Mode)
7+
8+
## Maintainer
9+
10+
- [USAMI Kenta (@zonuexe)](https://github.com/zonuexe) <tadsan@zonu,me>
11+
12+
## Retired Maintainers
13+
14+
- [Aaron S. Hawley](https://users.ninthfloor.org/~ashawley/)
15+
- [Lennart Borgman](https://www.emacswiki.org/emacs/LennartBorgman)
16+
- [Eric James Michael Ritz](https://github.com/ejmr)
17+
- [Syohei Yoshida](https://syohex.org/)
18+
19+
## Contributors
20+
21+
All contributors listed below improved PHP Mode as well.
22+
23+
Names Sorted Alphabetically:
24+
25+
- Alan Pearce
26+
- Andreas Röhler
27+
- Andrei Chițu
28+
- Bence Kalmar
29+
- Bob W. Hogg
30+
- Carl Groner
31+
- Charlie McMackin
32+
- Christian Albrecht
33+
- Daniel Hackney
34+
- David Arroyo Menéndez
35+
- David Maus
36+
- Demis Balbach
37+
- Elis Axelsson
38+
- Emanuele Tomasi
39+
- Engelke Eschner
40+
- Eric James Michael Ritz
41+
- François-Xavier Bois
42+
- Gu Weigang
43+
- Herbert Jones
44+
- Hernawan Fa'iz Abdillah
45+
- Jacek Wysocki
46+
- Jakub Jankiewicz
47+
- James Laver
48+
- Jeff Beeman
49+
- Joe Wreschnig
50+
- Jon Dufresne
51+
- Joris Steyn
52+
- Marcin Antczak
53+
- Mark A. Hershberger
54+
- Maël Nison
55+
- Michael Dwyer
56+
- Michael Stolovitzsky
57+
- Michele Bini
58+
- Nate Eagleson
59+
- Nicholas D Steeves
60+
- Olaf The Viking
61+
- Peter Oliver
62+
- Philippe Ivaldi
63+
- Sebastian Wiesner
64+
- Serghei Iakovlev
65+
- Syohei YOSHIDA
66+
- Tim Landscheidt
67+
- Tom Willemsen
68+
- U-CPT\deb
69+
- USAMI Kenta
70+
- fabacino
71+
- fallchildren
72+
- flack
73+
- l3msh0
74+
- phil-s
75+
- takeokunn
76+
- tangxinfa
77+
- tijsmallaerts
78+
- zapad
79+
- 顾伟刚

AUTHORS.md.in

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Authors
2+
3+
## Author
4+
5+
- [Turadg Aleahmad](https://github.com/turadg) (Original Author)
6+
- [Daniel Hackney](https://github.com/haxney) (Integrated with CC Mode)
7+
8+
## Maintainer
9+
10+
- [USAMI Kenta (@zonuexe)](https://github.com/zonuexe) <tadsan@zonu,me>
11+
12+
## Retired Maintainers
13+
14+
- [Aaron S. Hawley](https://users.ninthfloor.org/~ashawley/)
15+
- [Lennart Borgman](https://www.emacswiki.org/emacs/LennartBorgman)
16+
- [Eric James Michael Ritz](https://github.com/ejmr)
17+
- [Syohei Yoshida](https://syohex.org/)
18+
19+
## Contributors
20+
21+
All contributors listed below improved PHP Mode as well.
22+
23+
Names Sorted Alphabetically:
24+

Makefile

+13-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,18 @@ ELCS = $(ELS:.el=.elc)
66
%.elc: %.el
77
$(EMACS) -Q -batch -L . -f batch-byte-compile $<
88

9-
all: autoloads $(ELCS)
9+
all: autoloads $(ELCS) authors
10+
11+
authors: AUTHORS.md
12+
13+
.PHONY: AUTHORS.md
14+
AUTHORS.md: AUTHORS.md.in
15+
@printf "Generating AUTHORS.md file..."
16+
@test -d .git \
17+
&& (cat $< > $@ \
18+
&& git log --pretty=format:'- %aN' | sort -u >> $@ \
19+
&& printf "FINISHED\n" ; ) \
20+
|| printf "FAILED (non-fatal)\n"
1021

1122
autoloads: $(AUTOLOADS)
1223

@@ -40,4 +51,4 @@ test: clean all
4051
touch tests/project/1/.git
4152
$(EMACS) -Q -batch -L . -l tests/php-mode-test.el -f ert-run-tests-batch-and-exit
4253

43-
.PHONY: all autoloads clean test
54+
.PHONY: all authors autoloads clean test

README.ja.md

+49-86
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Emacs PHP Mode
1+
<div align="center">
2+
<h1>Emacs PHP Mode</h1>
23

34
[![Emacs: 26.3](https://img.shields.io/badge/Emacs-26.3-blue.svg)](https://www.gnu.org/software/emacs/)
45
[![lang: PHP 7](https://img.shields.io/badge/lang-PHP%207-brightgreen.svg)](http://php.net/manual/migration70.php)
@@ -8,22 +9,11 @@
89
[![melpa stable badge][melpa-stable-badge]][melpa-stable-link]
910
[![GPL v3](https://img.shields.io/badge/license-GPL_v3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.txt)
1011

11-
GNU EmacsでのPHPコーディングを支援するメジャーモードの開発プロジェクトです。
12-
これまで、以下の人々の作業をもとにフォークされました。
12+
A powerful and flexible Emacs major mode for editing PHP scripts
1313

14-
1. Turadg Aleahmad (Original Author)
15-
2. Aaron S. Hawley
16-
3. Lennart Borgman
17-
4. Eric James Michael Ritz
18-
5. Syohei Yoshida
14+
</div>
1915

20-
リストアップされたすべての貢献者たちも同様にPHPモードを改善しました。
21-
22-
現在のメンテナ:
23-
24-
1. USAMI Kenta (@zonuexe)
25-
26-
[PHP ModeのGitHubプロジェクト][php-mode]にissueを作成してバグ報告や機能リクエストを送ってください。あるいは[PHP suite][php-suite][FeatHubページ][feathub]に機能リクエストを送っても構いません。
16+
[PHP ModeのGitHubプロジェクト][php-mode]にissueを作成してバグ報告や機能リクエストを送ってください。
2717

2818
インストール
2919
------------
@@ -38,63 +28,15 @@ GNU Emacs 24以降では、[package][]機能(または[Cask][])を使って[MELP
3828

3929
### OSのパッケージマネージャからのインストール
4030

41-
PHP Modeは[いくつかのOSが提供するパッケージシステム](https://repology.org/project/emacs:php-mode/versions)からインストール可能です。これはEmacsにPHPを追加する最も簡単な方法で、ただ `sudo apt-get install elpa-php-mode` で導入できます。
31+
PHP Modeは[いくつかのOSが提供するパッケージシステム][php-mode-packages]からインストール可能です。DebianおよびUbuntuのようなDebian派生のOSではEmacsにPHPを追加する最も簡単な方法で、`sudo apt install elpa-php-mode` で導入できます。これらの "Stable" リリースは最新のPHP Modeよりも古いものの、十分にテストされた固定バージョンが提供されます。オートロードとバイトコンパイルは自動で行われます
4232

43-
Debian、Ubuntuや派生OSなどでのパッケージ名は[`elpa-php-mode`](https://packages.debian.org/buster/elpa-php-mode)です。これらのパッケージは安定版ですが、PHP Modeの最新版からは遅れているため、最新のPHP機能サポートや性能改善が反映されていない可能性があることに気をつけてください
33+
最新のPHP Modeの機能とパフォーマンス改善を活用するために**sid** ("unstable"としても知られるローリングリリース)で提供されるバージョンのインストールを検討してください。最新バージョンは[`elpa-php-mode`][elpa-php-mode]にあります。"apt-pinning"を使ってアップデートを自動化することもできます
4434

45-
また、[Debian 9 (stretch)](https://packages.debian.org/stretch/php-elisp)[Ubuntu 18.10](https://packages.ubuntu.com/cosmic/php-elisp)以前で提供されていた `php-elisp` パッケージは[あまりにも古い](https://github.com/emacs-php/php-mode/issues/430)ので、 **くれぐれもインストールしないでください**
35+
また、[Debian 9 (stretch)][php-elisp-stretch][Ubuntu 18.10][php-elisp-ubuntu1810]以前で提供されていた `php-elisp` パッケージは[あまりにも古い][issue-430]ので、 **くれぐれもインストールしないでください**
4636

4737
### 手動でインストール
4838

49-
このプロジェクトを `git cline` または、[php-mode releases]からzip/tarアーカイブをダウンロードして展開してください。
50-
51-
#### A: `(load php-mode-autoloads.el)` *(推奨)*
52-
53-
これはパッケージマネージャを利用した場合と同等のパフォーマンスと使いやすさを両立した初期化方法です。
54-
55-
ダウンロードしたコードを展開したディレクトリに移動し、`make`コマンドを実行すると、バイトコンパイルおよび `php-mode-autoloads.el` を生成できます。 `init.el`からファイルをロードするだけで使用準備は完了です。
56-
57-
```el
58-
;; Put follow code into init.el
59-
(when (file-directory-p "~/path/to/php-mode")
60-
(load "~/path/to/php-mode/php-mode-autoloads.el"))
61-
62-
;; Any code below is *unnecessary*
63-
;; (require 'php-mode)
64-
;; (add-to-list 'load-path (expand-file-name "~/path/to/php-mode"))
65-
;; (add-to-list 'auto-mode-alist '("\\.php\\'" . php-mode))
66-
```
67-
68-
#### **B**: `(autoload 'php-mode)`
69-
70-
Emacs起動時の僅かな読み込み増加をも削減したい上級ユーザー向けです。
71-
72-
この場合も `make`でバイトコンパイルしておくことを推奨します。
73-
74-
```el
75-
;; Put follow code into init.el
76-
(autoload 'php-mode (expand-file-name "~/path/to/php-mode/php-mode") "\
77-
Major mode for editing PHP code.
78-
79-
\\{php-mode-map}
80-
81-
\(fn)" t nil)
82-
83-
(add-to-list 'auto-mode-alist '("\\.\\(?:php\\|phtml\\)\\'" . php-mode))
84-
85-
;; Any code below is *unnecessary*
86-
;; (add-to-list 'load-path (expand-file-name "~/path/to/php-mode"))
87-
;; (require 'php-mode)
88-
```
89-
90-
#### **C**: `(require 'php-mode)` *(非推奨)*
91-
92-
特定のパスから`php-mode`を同期的に読み込みます。 **A**の場合と比べて10倍のサイズのコードを読み込むことになり、起動時間の増加幅はCPUとファイスシステムのパフォーマンスに依存します。
93-
94-
```el
95-
(require 'php-mode "~/path/to/php-mode/php-mode")
96-
(add-to-list 'load-path (expand-file-name "~/path/to/php-mode"))
97-
```
39+
もしパッケージマネージャに依存したくなければ、伝統的な方法によってLispファイルを直接インストールすることもできます。詳細なセットアップ方法は[手動でのインストール][wiki-manual-installation-ja]ページをご覧ください。
9840

9941
バグを報告する
10042
--------------
@@ -310,10 +252,6 @@ GNU Emacsには[Subword Mode][]という機能があり、このマイナーモ
310252

311253
キーバインド `C-c C-w` はSubword Modeのオンとオフを切り替えます。
312254

313-
### Amakaサポート
314-
315-
Viewing and editing build scripts for [Amaka](http://trashofmasters.github.io/amaka/) will automatically enable PHP Mode.
316-
317255
### 現在のclass/namespaceを挿入する
318256

319257
```el
@@ -356,34 +294,59 @@ Wiki
356294

357295
GitHubのプロジェクトページには[wiki][]があり、自由に編集して構いません。このWikiには今後追加する計画のある機能やバグが掲載されています。また、PHPモードをより使いやすくするためのTipsを追加できます。
358296

359-
ライセンス
360-
-------
361-
362-
PHP Mode uses the [GNU General Public License 3](http://www.gnu.org/copyleft/gpl.html).
363-
364-
Contributors
365-
------------
366-
367-
PHPモードの改善に協力したすべての貢献者のリストは[README.md#contributors](https://github.com/emacs-php/php-mode/blob/master/README.md#contributors)に掲載されています。
368-
297+
## 著作権
298+
299+
PHP Modeは[GNU General Public License Version 3][gpl-v3] (GPLv3) でライセンスされています。
300+
301+
このプロジェクトは1999年に[Turadg Aleahmad][@turadg]が書いた`php-mode.el`に起源を持ちます。2013年に[Daniel Hackney][@haxney]がEmacs組み込みのCC Modeをもとに書き直し始めました。PHPモードの改善に協力した貢献者のリストは[Authors][Contributors]に掲載されています。
302+
303+
このプロジェクトは2017年まで[Eric James Michael Ritz][@ejmr]によりメンテナンスされていました。現在は[Friends of Emacs-PHP Development][@emacs-php]コミュニティが引き継いで開発しています。
304+
305+
> ```
306+
> Copyright (C) 2018-2020 Friends of Emacs-PHP development
307+
> Copyright (C) 1999, 2000, 2001, 2003, 2004 Turadg Aleahmad
308+
> 2008 Aaron S. Hawley
309+
> 2011, 2012, 2013, 2014, 2015, 2016, 2017 Eric James Michael Ritz
310+
> ```
311+
>
312+
> This program is free software; you can redistribute it and/or modify
313+
> it under the terms of the GNU General Public License as published by
314+
> the Free Software Foundation, either version 3 of the License, or
315+
> (at your option) any later version.
316+
>
317+
> This program is distributed in the hope that it will be useful,
318+
> but WITHOUT ANY WARRANTY; without even the implied warranty of
319+
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
320+
> GNU General Public License for more details.
321+
>
322+
> You should have received a copy of the GNU General Public License
323+
> along with this program. If not, see <https://www.gnu.org/licenses/>.
324+
325+
[@ejmr]: https://github.com/ejmr
326+
[@emacs-php]: https://github.com/emacs-php
327+
[@haxney]: https://github.com/haxney
328+
[@turadg]: https://github.com/turadg
329+
[Authors]: https://github.com/emacs-php/php-mode/wiki/Authors
369330
[Cask]: https://github.com/cask/cask
331+
[Contributors]: https://github.com/emacs-php/php-mode/graphs/contributors
370332
[MELPA Stable]: https://stable.melpa.org/
371333
[MELPA]: https://melpa.org/
372-
[Marmalade]: http://marmalade-repo.org/
373334
[Subword Mode]: https://www.gnu.org/software/emacs/manual/html_node/ccmode/Subword-Movement.html
374335
[Supported Version]: https://github.com/emacs-php/php-mode/wiki/Supported-Version
375336
[Web Mode]: http://web-mode.org/
376337
[camelCase]: https://ja.wikipedia.org/wiki/%E3%82%AD%E3%83%A3%E3%83%A1%E3%83%AB%E3%82%B1%E3%83%BC%E3%82%B9
377338
[cc mode]: https://www.gnu.org/software/emacs/manual/html_mono/ccmode.html
378-
[feathub]: https://feathub.com/emacs-php/php-suite
339+
[elpa-php-mode]: https://packages.debian.org/sid/elpa-php-mode
340+
[issue-430]: https://github.com/emacs-php/php-mode/issues/430
379341
[melpa-badge]: http://melpa.org/packages/php-mode-badge.svg
380342
[melpa-link]: http://melpa.org/#/php-mode
381343
[melpa-stable-badge]: http://stable.melpa.org/packages/php-mode-badge.svg
382344
[melpa-stable-link]: http://stable.melpa.org/#/php-mode
383345
[package]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Packages.html
346+
[php-elisp-stretch]: https://packages.debian.org/stretch/php-elisp
347+
[php-elisp-ubuntu1810]: https://packages.ubuntu.com/cosmic/php-elisp
348+
[php-mode-packages]: https://repology.org/project/emacs:php-mode/versions
384349
[php-mode]: https://github.com/emacs-php/php-mode
385-
[php-mode releases]: https://github.com/emacs-php/php-mode/releases
386350
[php-suite]: https://github.com/emacs-php/php-suite
387-
[travis-badge]: https://travis-ci.org/emacs-php/php-mode.svg
388-
[travis-link]: https://travis-ci.org/emacs-php/php-mode
389351
[wiki]: https://github.com/emacs-php/php-mode/wiki
352+
[wiki-manual-installation-ja]: https://github.com/emacs-php/php-mode/wiki/Manual-installation-ja

0 commit comments

Comments
 (0)