Skip to content

Update readme #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jan 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Authors

## Author

- [Turadg Aleahmad](https://github.com/turadg) (Original Author)
- [Daniel Hackney](https://github.com/haxney) (Integrated with CC Mode)

## Maintainer

- [USAMI Kenta (@zonuexe)](https://github.com/zonuexe) <tadsan@zonu,me>

## Retired Maintainers

- [Aaron S. Hawley](https://users.ninthfloor.org/~ashawley/)
- [Lennart Borgman](https://www.emacswiki.org/emacs/LennartBorgman)
- [Eric James Michael Ritz](https://github.com/ejmr)
- [Syohei Yoshida](https://syohex.org/)

## Contributors

All contributors listed below improved PHP Mode as well.

Names Sorted Alphabetically:

- Alan Pearce
- Andreas Röhler
- Andrei Chițu
- Bence Kalmar
- Bob W. Hogg
- Carl Groner
- Charlie McMackin
- Christian Albrecht
- Daniel Hackney
- David Arroyo Menéndez
- David Maus
- Demis Balbach
- Elis Axelsson
- Emanuele Tomasi
- Engelke Eschner
- Eric James Michael Ritz
- François-Xavier Bois
- Gu Weigang
- Herbert Jones
- Hernawan Fa'iz Abdillah
- Jacek Wysocki
- Jakub Jankiewicz
- James Laver
- Jeff Beeman
- Joe Wreschnig
- Jon Dufresne
- Joris Steyn
- Marcin Antczak
- Mark A. Hershberger
- Maël Nison
- Michael Dwyer
- Michael Stolovitzsky
- Michele Bini
- Nate Eagleson
- Nicholas D Steeves
- Olaf The Viking
- Peter Oliver
- Philippe Ivaldi
- Sebastian Wiesner
- Serghei Iakovlev
- Syohei YOSHIDA
- Tim Landscheidt
- Tom Willemsen
- U-CPT\deb
- USAMI Kenta
- fabacino
- fallchildren
- flack
- l3msh0
- phil-s
- takeokunn
- tangxinfa
- tijsmallaerts
- zapad
- 顾伟刚
24 changes: 24 additions & 0 deletions AUTHORS.md.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Authors

## Author

- [Turadg Aleahmad](https://github.com/turadg) (Original Author)
- [Daniel Hackney](https://github.com/haxney) (Integrated with CC Mode)

## Maintainer

- [USAMI Kenta (@zonuexe)](https://github.com/zonuexe) <tadsan@zonu,me>

## Retired Maintainers

- [Aaron S. Hawley](https://users.ninthfloor.org/~ashawley/)
- [Lennart Borgman](https://www.emacswiki.org/emacs/LennartBorgman)
- [Eric James Michael Ritz](https://github.com/ejmr)
- [Syohei Yoshida](https://syohex.org/)

## Contributors

All contributors listed below improved PHP Mode as well.

Names Sorted Alphabetically:

15 changes: 13 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,18 @@ ELCS = $(ELS:.el=.elc)
%.elc: %.el
$(EMACS) -Q -batch -L . -f batch-byte-compile $<

all: autoloads $(ELCS)
all: autoloads $(ELCS) authors

authors: AUTHORS.md

.PHONY: AUTHORS.md
AUTHORS.md: AUTHORS.md.in
@printf "Generating AUTHORS.md file..."
@test -d .git \
&& (cat $< > $@ \
&& git log --pretty=format:'- %aN' | sort -u >> $@ \
&& printf "FINISHED\n" ; ) \
|| printf "FAILED (non-fatal)\n"

autoloads: $(AUTOLOADS)

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

.PHONY: all autoloads clean test
.PHONY: all authors autoloads clean test
135 changes: 49 additions & 86 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Emacs PHP Mode
<div align="center">
<h1>Emacs PHP Mode</h1>

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

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

1. Turadg Aleahmad (Original Author)
2. Aaron S. Hawley
3. Lennart Borgman
4. Eric James Michael Ritz
5. Syohei Yoshida
</div>

リストアップされたすべての貢献者たちも同様にPHPモードを改善しました。

現在のメンテナ:

1. USAMI Kenta (@zonuexe)

[PHP ModeのGitHubプロジェクト][php-mode]にissueを作成してバグ報告や機能リクエストを送ってください。あるいは[PHP suite][php-suite]の[FeatHubページ][feathub]に機能リクエストを送っても構いません。
[PHP ModeのGitHubプロジェクト][php-mode]にissueを作成してバグ報告や機能リクエストを送ってください。

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

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

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

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

また、[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)ので、 **くれぐれもインストールしないでください**。
また、[Debian 9 (stretch)][php-elisp-stretch]や[Ubuntu 18.10][php-elisp-ubuntu1810]以前で提供されていた `php-elisp` パッケージは[あまりにも古い][issue-430]ので、 **くれぐれもインストールしないでください**。

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

このプロジェクトを `git cline` または、[php-mode releases]からzip/tarアーカイブをダウンロードして展開してください。

#### A: `(load php-mode-autoloads.el)` *(推奨)*

これはパッケージマネージャを利用した場合と同等のパフォーマンスと使いやすさを両立した初期化方法です。

ダウンロードしたコードを展開したディレクトリに移動し、`make`コマンドを実行すると、バイトコンパイルおよび `php-mode-autoloads.el` を生成できます。 `init.el`からファイルをロードするだけで使用準備は完了です。

```el
;; Put follow code into init.el
(when (file-directory-p "~/path/to/php-mode")
(load "~/path/to/php-mode/php-mode-autoloads.el"))

;; Any code below is *unnecessary*
;; (require 'php-mode)
;; (add-to-list 'load-path (expand-file-name "~/path/to/php-mode"))
;; (add-to-list 'auto-mode-alist '("\\.php\\'" . php-mode))
```

#### **B**: `(autoload 'php-mode)`

Emacs起動時の僅かな読み込み増加をも削減したい上級ユーザー向けです。

この場合も `make`でバイトコンパイルしておくことを推奨します。

```el
;; Put follow code into init.el
(autoload 'php-mode (expand-file-name "~/path/to/php-mode/php-mode") "\
Major mode for editing PHP code.

\\{php-mode-map}

\(fn)" t nil)

(add-to-list 'auto-mode-alist '("\\.\\(?:php\\|phtml\\)\\'" . php-mode))

;; Any code below is *unnecessary*
;; (add-to-list 'load-path (expand-file-name "~/path/to/php-mode"))
;; (require 'php-mode)
```

#### **C**: `(require 'php-mode)` *(非推奨)*

特定のパスから`php-mode`を同期的に読み込みます。 **A**の場合と比べて10倍のサイズのコードを読み込むことになり、起動時間の増加幅はCPUとファイスシステムのパフォーマンスに依存します。

```el
(require 'php-mode "~/path/to/php-mode/php-mode")
(add-to-list 'load-path (expand-file-name "~/path/to/php-mode"))
```
もしパッケージマネージャに依存したくなければ、伝統的な方法によってLispファイルを直接インストールすることもできます。詳細なセットアップ方法は[手動でのインストール][wiki-manual-installation-ja]ページをご覧ください。

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

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

### Amakaサポート

Viewing and editing build scripts for [Amaka](http://trashofmasters.github.io/amaka/) will automatically enable PHP Mode.

### 現在のclass/namespaceを挿入する

```el
Expand Down Expand Up @@ -356,34 +294,59 @@ Wiki

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

ライセンス
-------

PHP Mode uses the [GNU General Public License 3](http://www.gnu.org/copyleft/gpl.html).

Contributors
------------

PHPモードの改善に協力したすべての貢献者のリストは[README.md#contributors](https://github.com/emacs-php/php-mode/blob/master/README.md#contributors)に掲載されています。

## 著作権

PHP Modeは[GNU General Public License Version 3][gpl-v3] (GPLv3) でライセンスされています。

このプロジェクトは1999年に[Turadg Aleahmad][@turadg]が書いた`php-mode.el`に起源を持ちます。2013年に[Daniel Hackney][@haxney]がEmacs組み込みのCC Modeをもとに書き直し始めました。PHPモードの改善に協力した貢献者のリストは[Authors]と[Contributors]に掲載されています。

このプロジェクトは2017年まで[Eric James Michael Ritz][@ejmr]によりメンテナンスされていました。現在は[Friends of Emacs-PHP Development][@emacs-php]コミュニティが引き継いで開発しています。

> ```
> Copyright (C) 2018-2020 Friends of Emacs-PHP development
> Copyright (C) 1999, 2000, 2001, 2003, 2004 Turadg Aleahmad
> 2008 Aaron S. Hawley
> 2011, 2012, 2013, 2014, 2015, 2016, 2017 Eric James Michael Ritz
> ```
>
> This program is free software; you can redistribute it and/or modify
> it under the terms of the GNU General Public License as published by
> the Free Software Foundation, either version 3 of the License, or
> (at your option) any later version.
>
> This program is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> GNU General Public License for more details.
>
> You should have received a copy of the GNU General Public License
> along with this program. If not, see <https://www.gnu.org/licenses/>.

[@ejmr]: https://github.com/ejmr
[@emacs-php]: https://github.com/emacs-php
[@haxney]: https://github.com/haxney
[@turadg]: https://github.com/turadg
[Authors]: https://github.com/emacs-php/php-mode/wiki/Authors
[Cask]: https://github.com/cask/cask
[Contributors]: https://github.com/emacs-php/php-mode/graphs/contributors
[MELPA Stable]: https://stable.melpa.org/
[MELPA]: https://melpa.org/
[Marmalade]: http://marmalade-repo.org/
[Subword Mode]: https://www.gnu.org/software/emacs/manual/html_node/ccmode/Subword-Movement.html
[Supported Version]: https://github.com/emacs-php/php-mode/wiki/Supported-Version
[Web Mode]: http://web-mode.org/
[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
[cc mode]: https://www.gnu.org/software/emacs/manual/html_mono/ccmode.html
[feathub]: https://feathub.com/emacs-php/php-suite
[elpa-php-mode]: https://packages.debian.org/sid/elpa-php-mode
[issue-430]: https://github.com/emacs-php/php-mode/issues/430
[melpa-badge]: http://melpa.org/packages/php-mode-badge.svg
[melpa-link]: http://melpa.org/#/php-mode
[melpa-stable-badge]: http://stable.melpa.org/packages/php-mode-badge.svg
[melpa-stable-link]: http://stable.melpa.org/#/php-mode
[package]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Packages.html
[php-elisp-stretch]: https://packages.debian.org/stretch/php-elisp
[php-elisp-ubuntu1810]: https://packages.ubuntu.com/cosmic/php-elisp
[php-mode-packages]: https://repology.org/project/emacs:php-mode/versions
[php-mode]: https://github.com/emacs-php/php-mode
[php-mode releases]: https://github.com/emacs-php/php-mode/releases
[php-suite]: https://github.com/emacs-php/php-suite
[travis-badge]: https://travis-ci.org/emacs-php/php-mode.svg
[travis-link]: https://travis-ci.org/emacs-php/php-mode
[wiki]: https://github.com/emacs-php/php-mode/wiki
[wiki-manual-installation-ja]: https://github.com/emacs-php/php-mode/wiki/Manual-installation-ja
Loading