summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpurwandi <free6300@gmail.com>2011-09-08 17:16:55 +0200
committerpurwandi <free6300@gmail.com>2011-09-08 17:16:55 +0200
commit6855e9c78332ef8f548f33133d3c2bb4cd6691b6 (patch)
treea90f9eb6c8a8607f5616816bd29dc19784ffccdb
parent80023511af5dfb47b01ca1381da22490319835a2 (diff)
Fix some text
-rw-r--r--readme.md26
1 files changed, 18 insertions, 8 deletions
diff --git a/readme.md b/readme.md
index 7d7bf9d4a..b28329234 100644
--- a/readme.md
+++ b/readme.md
@@ -2,27 +2,27 @@
CodeIgniter is an Application Development Framework - a toolkit - for people who build web sites using PHP. Its goal is to enable you to develop projects much faster than you could if you were writing code from scratch, by providing a rich set of libraries for commonly needed tasks, as well as a simple interface and logical structure to access these libraries. CodeIgniter lets you creatively focus on your project by minimizing the amount of code needed for a given task.
-# Release Information
+## Release Information
CodeIgniter 2.1.0 Dev
THIS RELASE IS A DEVELOPMENT REALEASE AND NOT INTENDED FOR PRODUCTION USE.
PLASE USE AT YOUR OWN RISK
-# Changelog and New Feature
+## Changelog and New Feature
You can find it on [user_guide/changelog.html](https://github.com/EllisLab/CodeIgniter/blob/develop/user_guide/changelog.html)
-# Server Requirements
+## Server Requirements
* PHP version 5.1.6 or newer.
* A Database is required for most web application programming. Current supported databases are MySQL (4.1+), MySQLi, MS SQL, Postgres, Oracle, SQLite, ODBC and CUBRID.
-# Installation
+## Installation
Please see file on [CodeIgniter User Guide](http://codeigniter.com/user_guide/installation/index.html)
-# Contributing
+## Contributing
CodeIgniter is a community driven project and accepts contributions of code and documentation from the community. These contributions are made in the form of Issues or [Pull Requests](http://help.github.com/send-pull-requests/) on the [EllisLab CodeIgniter repository](https://github.com/EllisLab/CodeIgniter) on GitHub.
@@ -34,7 +34,9 @@ Issues are a quick way to point out a bug. If you find a bug or documentation er
Is it something really obvious that you fix it yourself?
Reporting issues is helpful but an even better approach is to send a Pull Request, which is done by “Forking” the main repository and committing to your own copy. This will require you to use the version control system called Git.
+
Guidelines
+----------
Before we look into how, here are the guidelines. If your Pull Requests fail to pass these guidelines it will be declined and you will need to re-submit when you’ve made the changes. This might sound a bit tough, but it is required for us to maintain quality of the code-base.
@@ -47,7 +49,10 @@ Compatibility: CodeIgniter is compatible with PHP 5.1.6 so all code supplied mus
Branching: CodeIgniter uses the [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model which requires all pull requests to be sent to the “develop” branch. This is where the next planned version will be developed. The “master” branch will always contain the latest stable version and is kept clean so a “hotfix” (e.g: an emergency security patch) can be applied to master to create a new version, without worrying about other features holding it up. For this reason all commits need to be made to “develop” and any sent to “master” will be closed automatically. If you have multiple changes to submit, please place all changes into their own branch on your fork.
One thing at a time: A pull request should only contain one change. That does not mean only one commit, but one change - however many commits it took. The reason for this is that if you change X and Y but send a pull request for both at the same time, we might really want X but disagree with Y, meaning we cannot merge the request. Using the Git-Flow branching model you can create new branches for both of these features and send two requests.
+
How-to Guide
+------------
+
There are two ways to make changes, the easy way and the hard way. Either way you will need to [create a GitHub account](https://github.com/signup/free).
Easy way
@@ -81,15 +86,20 @@ If you are using command-line you can do the following:
Now your fork is up to date. This should be done regularly, or before you send a pull request at least.
-# License
+## License
The files in this archive are released under the EllisLab's license.
You can find a copy of this license in license.txt.
-# Resources
+## Resources
* [User Guide](http://codeigniter.com/user_guide/)
* [Community Forums](http://codeigniter.com/forums/)
* [User Voice](http://codeigniter.uservoice.com/forums/40508-codeigniter-reactor)
* [Community Wiki](http://codeigniter.com/wiki/)
- * [Community IRC](http://codeigniter.com/irc/) \ No newline at end of file
+ * [Community IRC](http://codeigniter.com/irc/)
+
+## Acknowledgement
+
+The EllisLab's team and The Reactor Engineers would like to thank all the contributors to the CodeIgniter project, our corporate sponsor, and you, the CodeIgniter user.
+Please visit us sometime soon at [CodeIgniter](http://codeigniter.com) \ No newline at end of file