ソースを参照

Updated README.

Piotrek Koszuliński 10 年 前
コミット
63fe97ca53
1 ファイル変更30 行追加9 行削除
  1. 30 9
      README.md

+ 30 - 9
README.md

@@ -1,23 +1,44 @@
-CKEditor 5 - Development Repository
+CKEditor 5  Development Repository
 ===================================
 
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5.svg)](https://david-dm.org/ckeditor/ckeditor5)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5#info=devDependencies)
 
-This repository contains the development version of CKEditor 5, the next generation WYSIWYG editing platform and solutions.
+## Project Status (January 2016)
 
-## Current Status
+**WARNING:** The project is still at its first development stage. No usable software is currently available.
 
-**WARNING**: Development just started and this repository still doesn't contain usable software.
+[Periodic updates and news](https://github.com/ckeditor/ckeditor5/wiki/News-and-Updates) about the project can be found at the wiki pages of [ckeditor5](https://github.com/ckeditor/ckeditor5).
 
-## Key Repositories
+## Project Organization
 
-The [ckeditor5-design](https://github.com/ckeditor/ckeditor5-design) repository concentrates the whole design effort around CKEditor 5. Information can be found at its [wiki](https://github.com/ckeditor/ckeditor5-design/wiki) and [issues](https://github.com/ckeditor/ckeditor5-design/issues) pages.
+### Design
 
-The [ckeditor5](https://github.com/ckeditor/ckeditor5) repository instead centralizes the official code produced by the project. Code available here should be pretty much final. Its [issues](https://github.com/ckeditor/ckeditor5-design/issues) page is the place where to report issues regarding releases features and about the project as a whole.
+Discussions, decisions and documentation about the architecture design of CKEditor 5 are made at the "ckeditor5-design" repository:
 
-The [ckeditor5-core](https://github.com/ckeditor/ckeditor5-core) repository keeps the editor's core modules such as the basic infrastructure, the data model and the basic UI library. **Most of the development happens in this repository.**
+* Discussion: https://github.com/ckeditor/ckeditor5-design/issues
+* Documentation: https://github.com/ckeditor/ckeditor5-design/wiki
+
+At the current stage, this is the best place for bringing opinions and contributions. Letting the core team know if they are going in the right or wrong direction is great feedback.
+
+### Development
+
+The project is split into several different repositories, as described in the [design wiki](https://github.com/ckeditor/ckeditor5-design/wiki/Architecture-Overview). Most of these repositories are generally available within the CKEditor organization in GitHub, prefixed with "ckeditor5".
+
+The [ckeditor5](https://github.com/ckeditor/ckeditor5) repository is the place that centralizes the development of CKEditor 5. It bundles different repositories into a single place, adding the necessary helper tools for the development workflow, like the builder and the test runner. [Basic information on how to setup the development environment](https://github.com/ckeditor/ckeditor5/wiki/Development-Environment) can be found in the wiki pages.
+
+![CKEditor 5 Development repository = Developer Tools (builder, test runner) + NPM packages (ckeditor5-core and others)](https://cloud.githubusercontent.com/assets/630060/12577912/d5c32244-c41d-11e5-8b09-2dd97a1abb05.png)
+
+A key repository is [ckeditor5-core](https://github.com/ckeditor/ckeditor5-core), which keeps the editor's core modules such as the basic infrastructure, the data model and the basic UI library. **Most of the development happens in this repository**.
+
+### Reporting Issues and Feature Requests
+
+Each repository independently handles its issues, so focus is kept on their scope:
+[ckeditor5-design](https://github.com/ckeditor/ckeditor5-design): issues related to macro program design, not going into the specifics of other repos.
+[ckeditor5](https://github.com/ckeditor/ckeditor5): issues related to the development environment and workflow.
+[ckeditor5-core](https://github.com/ckeditor/ckeditor5-core): issues related to the core API.
+other [ckeditor5-*](https://github.com/ckeditor?utf8=%E2%9C%93&query=ckeditor5-) repos: issues related to all other parts of the code, like features, UI libraries, themes, etc.
 
 ## License
 
-Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the `LICENSE.md` file.
+Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.