kylefang/ProMotion
1
0
Fork 0
mirror of https://github.com/zhigang1992/ProMotion.git synced 2026-03-26 06:55:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Move README to index to get readthedocs to work

Browse Source
This commit is contained in:
Jamon Holmgren
2015-04-18 14:30:55 -07:00
parent 57e3341009
commit 32b8cae3cf
2 changed files with 49 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/README.md
View File

@@ -1,48 +0,0 @@
## Welcome to the ProMotion docs!
Documentation is targeting ProMotion 2.3.x. Any exceptions will be noted.
If you have a problem with *any* of the documentation, *please* [open an issue](https://github.com/clearsightstudio/ProMotion/issues) so we can resolve it quickly.
### Getting Started
#### [Getting Started with ProMotion](./Guides/Guide - Getting Started.md)
Everything you need to know to install ProMotion and create your first iPhone app.
### Goal/Philosophy/Roadmap
ProMotion's goal is to create a **memorable**, **simple**, **intuitive**, and **enjoyable** API for
rapidly developing screen-based iPhone and iPad apps.
* **Memorable:** The API should be easy to memorize. Developers shouldn't have to be digging through documentation all the time to build out iOS apps.
* **Simple:** The API should utilize simple language, such as `open`, `close`, `add`, `remove`. Cocoa Touch is far too verbose.
* **Intuitive:** The API should make sense, even to developers unfamiliar with ProMotion.
* **Enjoyable:** The API should make developers feel like they're programming with purpose rather than implementing boilerplate. It should make iPhone and iPad development fun.
The philosophy behind ProMotion is to be a **friendly and welcoming community** to new iOS/RubyMotion developers. Many new ProMotion developers come from the web development world (Ruby on Rails, PHP) and have a lot of questions. Others come from non-English-speaking countries and may have difficulty understanding the documentation. **The more experienced ProMotion developers are encouraged to answer new developers' questions in good humor and with encouragement and patience.**
The current roadmap is to continue evolving the code's quality, performance, and maintainability. No major new features are currently planned. Most new features will be implemented in the form of [add-on gems](./Add-On-Gems), of which there are several already.
I don't want ProMotion to become bloated with little-used features. The features we've implemented so far have been commonly used ones that aren't easily available in other compatible and popular RubyMotion libraries. We will carefully consider pull requests, but the measure of whether something is accepted or not depends not only on its code quality but also its relevance and future maintainability.
*Visit the links in the sidebar to learn more about ProMotion's API.*
## Primary Contributors
|Contributor|Twitter|
|---|---|
|Jamon Holmgren|[@jamonholmgren](https://twitter.com/jamonholmgren)|
|Mark Rickert|[@markrickert](https://twitter.com/markrickert)|
|Silas J. Matson|[@silasjmatson](https://twitter.com/silasjmatson)|
|Ryan Linton|[@ryanlntn](https://twitter.com/ryanlntn)|
## Alumni
Matt Brewer [@macfanatic](https://twitter.com/macfanatic)
Many others contribute every day!

1
docs/README.md Symbolic link
View File

@@ -0,0 +1 @@
index.md

1
docs/index.md
View File

@@ -1 +0,0 @@
README.md

48
docs/index.md Normal file
View File

@@ -0,0 +1,48 @@
## Welcome to the ProMotion docs!
Documentation is targeting ProMotion 2.3.x. Any exceptions will be noted.
If you have a problem with *any* of the documentation, *please* [open an issue](https://github.com/clearsightstudio/ProMotion/issues) so we can resolve it quickly.
### Getting Started
#### [Getting Started with ProMotion](./Guides/Guide - Getting Started.md)
Everything you need to know to install ProMotion and create your first iPhone app.
### Goal/Philosophy/Roadmap
ProMotion's goal is to create a **memorable**, **simple**, **intuitive**, and **enjoyable** API for
rapidly developing screen-based iPhone and iPad apps.
* **Memorable:** The API should be easy to memorize. Developers shouldn't have to be digging through documentation all the time to build out iOS apps.
* **Simple:** The API should utilize simple language, such as `open`, `close`, `add`, `remove`. Cocoa Touch is far too verbose.
* **Intuitive:** The API should make sense, even to developers unfamiliar with ProMotion.
* **Enjoyable:** The API should make developers feel like they're programming with purpose rather than implementing boilerplate. It should make iPhone and iPad development fun.
The philosophy behind ProMotion is to be a **friendly and welcoming community** to new iOS/RubyMotion developers. Many new ProMotion developers come from the web development world (Ruby on Rails, PHP) and have a lot of questions. Others come from non-English-speaking countries and may have difficulty understanding the documentation. **The more experienced ProMotion developers are encouraged to answer new developers' questions in good humor and with encouragement and patience.**
The current roadmap is to continue evolving the code's quality, performance, and maintainability. No major new features are currently planned. Most new features will be implemented in the form of [add-on gems](./Add-On-Gems), of which there are several already.
I don't want ProMotion to become bloated with little-used features. The features we've implemented so far have been commonly used ones that aren't easily available in other compatible and popular RubyMotion libraries. We will carefully consider pull requests, but the measure of whether something is accepted or not depends not only on its code quality but also its relevance and future maintainability.
*Visit the links in the sidebar to learn more about ProMotion's API.*
## Primary Contributors
|Contributor|Twitter|
|---|---|
|Jamon Holmgren|[@jamonholmgren](https://twitter.com/jamonholmgren)|
|Mark Rickert|[@markrickert](https://twitter.com/markrickert)|
|Silas J. Matson|[@silasjmatson](https://twitter.com/silasjmatson)|
|Ryan Linton|[@ryanlntn](https://twitter.com/ryanlntn)|
## Alumni
Matt Brewer [@macfanatic](https://twitter.com/macfanatic)
Many others contribute every day!