Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update informative files

Update files for contributors and/or readers such as the index file
and the contribution file
  • Loading branch information...
commit 6f989967e913ad8496af648094b9c9b3001033f0 1 parent a4028a0
@robin850 authored
View
58 documentation/contribute.markdown
@@ -6,21 +6,23 @@ title: How To Contribute ?
# How To Contribute ? #
You can easily contribute to the Propel project since all projects are hosted by [GitHub](https://github.com).
-You just have to _fork_ the Propel project on the [PropelORM organization](https://github.com/propelorm) and
+You just have to _fork_ the Propel2 project on the [PropelORM organization](https://github.com/propelorm) and
to provide Pull Requests or to submit issues. Note, we are using [Git](http://git-scm.com) as main Source Code Management.
-The Propel organization maintains four projects:
+The Propel organization maintains five projects:
-* [Propel](http://github.com/propelorm/Propel) : the main project.
-* [PropelBundle](http://github.com/propelorm/PropelBundle) : a bundle to integrate Propel with [Symfony2](http://www.symfony.com).
-* [sfPropelORMPlugin](http://github.com/propelorm/sfPropelORMPlugin) : a plugin to integrate Propel with [symfony 1.x](http://www.symfony-project.org);
+* [Propel2](https://github.com/propelorm/Propel2) : the main version.
+* [Propel](https://github.com/propelorm/Propel) : the previous release of Propel.
+* [PropelBundle](https://github.com/propelorm/PropelBundle) : a bundle to integrate Propel with [Symfony2](http://www.symfony.com).
+* [sfPropelORMPlugin](https://github.com/propelorm/sfPropelORMPlugin) : a plugin to integrate Propel with [symfony 1.x](http://www.symfony-project.org);
* [propelorm.github.com](https://github.com/propelorm/propelorm.github.com) : the Propel documentation (aka this website).
## Submit an issue ##
The ticketing system is also hosted on GitHub:
-* Propel: [https://github.com/propelorm/Propel/issues](https://github.com/propelorm/Propel/issues)
+* Propel2: [https://github.com/propelorm/Propel2/issues](https://github.com/propelorm/Propel2/issues)
+* Propel (1.x): [https://github.com/propelorm/Propel/issues](https://github.com/propelorm/Propel/issues)
* PropelBundle: [https://github.com/propelorm/PropelBundle/issues](https://github.com/propelorm/PropelBundle/issues)
* sfPropelORMPlugin: [https://github.com/propelorm/sfPropelORMPlugin/issues](https://github.com/propelorm/sfPropelORMPlugin/issues)
@@ -30,7 +32,7 @@ The best way to submit a patch is to make a Pull Request on GitHub. First, you s
Assuming you are in your local Propel project:
```bash
-> git checkout -b master fix-my-patch
+$ git checkout -b master fix-my-patch
```
Now you can write your patch in this branch. Don't forget to provide unit tests with your fix to prove both the bug and the patch.
@@ -39,10 +41,10 @@ It will ease the process to accept or refuse a Pull Request.
When you're done, you have to rebase your branch to provide a clean and safe Pull Request.
```bash
-> git checkout master
-> git pull --ff-only upstream master
-> git checkout fix-my-patch
-> git rebase master
+$ git checkout master
+$ git pull --ff-only upstream master
+$ git checkout fix-my-patch
+$ git rebase master
```
In this example, the `upstream` remote is the PropelORM organization repository.
@@ -50,7 +52,7 @@ In this example, the `upstream` remote is the PropelORM organization repository.
Once done, you can submit the Pull Request by pushing your branch to your fork:
```bash
-> git push origin fix-my-patch
+$ git push origin fix-my-patch
```
Go to www.github.com and press the _Pull Request_ button. Add a short description to this Pull Request and submit it.
@@ -66,8 +68,8 @@ You can find the unit test classes and support files in the `test/testsuite` dir
In order to run the tests, you must install PHPUnit:
```bash
-> pear channel-discover pear.phpunit.de
-> pear install phpunit/PHPUnit
+$ pear channel-discover pear.phpunit.de
+$ pear install phpunit/PHPUnit
```
### Configure the Database to be Used in the Tests ###
@@ -79,7 +81,7 @@ You must configure both the generator and the runtime connection settings.
propel.database = mysql
propel.database.url = mysql:dbname=test
propel.mysqlTableType = InnoDB
-propel.disableIdentifierQuoting=true
+propel.disableIdentifierQuoting = true
# For MySQL or Oracle, you also need to specify username & password
propel.database.user = myusername
propel.database.password = p@ssw0rd
@@ -121,10 +123,10 @@ propel.database.password = p@ssw0rd
### Build the Propel Model and Initialize the Database ###
```bash
-> cd /path/to/propel/test
-> ../generator/bin/propel-gen fixtures/bookstore main
-> mysqladmin create test
-> ../generator/bin/propel-gen fixtures/bookstore insert-sql
+$ cd /path/to/propel/test
+$ ../generator/bin/propel-gen fixtures/bookstore main
+$ mysqladmin create test
+$ ../generator/bin/propel-gen fixtures/bookstore insert-sql
```
>**Tip**<br />To run the unit tests for the namespace support in PHP 5.3, you must also build the `fixtures/namespaced/` project.
@@ -155,8 +157,8 @@ GRANT ALL ON reverse_bookstore.* TO ''@'localhost';
You can build all fixtures by running the `reset_tests.sh` shell script:
```bash
-> cd /path/to/propel/test
-> ./reset_tests.sh
+$ cd /path/to/propel/test
+$ ./reset_tests.sh
```
### Run the Unit Tests ###
@@ -164,17 +166,15 @@ You can build all fixtures by running the `reset_tests.sh` shell script:
Run all the unit tests at once using the `phpunit` command:
```bash
-> cd /path/to/propel/test
-> phpunit testsuite
+$ cd /path/to/propel/test
+$ phpunit testsuite
```
->**Warning**<br />The `testsuite/generator/builder/NamespaceTest.php` file uses PHP 5.3 namespaces, and therefore will create a parse error under PHP 5.2. To launch the unit test suite in a PHP 5.2 platform, simply delete this test file.
-
To run a single test, go inside the unit test directory, and run the test using the command line. For example to run only GeneratedObjectTest:
-```bash
-> cd testsuite/generator/builder/om
-> phpunit GeneratedObjectTest
+```
+$ cd testsuite/generator/builder/om
+$ phpunit GeneratedObjectTest
```
### How the Tests Work ###
@@ -215,7 +215,7 @@ public function testSaveWithDefaultValues() {
Run the test again using the command line to check that it passes:
```bash
-> phpunit GeneratedObjectTest
+$ phpunit GeneratedObjectTest
```
You can also write additional unit test classes to any of the directories in `test/testsuite/` (or add new directories if needed). The `phpunit` command will find these files automatically and run them.
View
44 documentation/download.markdown
@@ -7,24 +7,46 @@ title: Download Propel
For a full installation tutorial, check the [Installation documentation](documentation/01-installation). The following options allow you to download the Propel code and documentation.
+## Composer ##
+
+You can download Propel using Composer. First, download the `composer.phar` file using one of the following command depending on your system:
+
+```bash
+$ curl -sS https://getcomposer.org/installer | php
+# Alternatively
+$ wget http://getcomposer.org/composer.phar
+```
+
+Then touch a `composer.json` file with the following content
+
+```json
+{
+ "require": {
+ "propel/propel": ">= 2.0"
+ }
+}
+```
+
+Then simply run `php composer.phar install` to fetch Propel and its dependencies.
+
## Git ##
Clone it:
```bash
-> git clone git://github.com/propelorm/Propel.git
+$ git clone git://github.com/propelorm/Propel2.git
```
Or add it as a submodule:
```bash
-> git submodule add git://github.com/propelorm/Propel.git /path/to/propel
+$ git submodule add git://github.com/propelorm/Propel2.git /path/to/propel
```
## Subversion Checkout / Externals ##
```bash
-> svn co http://svn.github.com/propelorm/Propel.git
+$ svn co http://svn.github.com/propelorm/Propel2.git
```
>**Warning**<br />SVN is no more the default Source Code Management since 2011.
@@ -34,16 +56,8 @@ Or add it as a submodule:
Propel is available through its own PEAR channel [pear.propelorm.org](pear.propelorm.org), in two separate packages for generator and runtime:
```bash
-> pear channel-discover pear.propelorm.org
-> sudo pear install -a propel/propel_generator
-> sudo pear install -a propel/propel_runtime
-```
-
-Propel depends on the Phing library, and the dependency should be properly handled by PEAR thanks to the -a option above. Alternatively, you can install Phing separately:
-
-```bash
-> pear channel-discover pear.phing.info
-> sudo pear install phing/phing
+$ pear channel-discover pear.propelorm.org
+$ sudo pear install -a propel/Propel2
```
>**Tip**<br />If you would like to use a beta or RC version of Propel, you may need to change your preferred_state PEAR environment variable.
@@ -52,8 +66,8 @@ Propel depends on the Phing library, and the dependency should be properly handl
Please download one of the packages below if you would like to install the traditional Propel package, which includes both runtime and generator components.
-* [Last version of Propel as ZIP file](https://github.com/propelorm/Propel/zipball/master)
-* [Last version of Propel as TAR.GZ file](https://github.com/propelorm/Propel/tarball/master)
+* [Last version of Propel as ZIP file](https://github.com/propelorm/Propel2/zipball/master)
+* [Last version of Propel as TAR.GZ file](https://github.com/propelorm/Propel2/tarball/master)
Other releases are available for download at [files.propelorm.org](http://files.propelorm.org).
View
8 documentation/index.markdown
@@ -33,13 +33,13 @@ $books = BookQuery::create() // retrieve all books...
->joinWith('Book.Author') // ... with their author
->find();
foreach($books as $book) {
- echo $book->getAuthor()->getFullName();
+ echo $book->getAuthor()->getFullName();
}
```
### Get It! ###
-Fork the Propel GitHub repository at [http://github.com/propelorm/propel](http://github.com/propelorm/propel).
+Fork the Propel GitHub repository at [http://github.com/propelorm/Propel2](https://github.com/propelorm/Propel2).
### Dive In! ###
@@ -53,8 +53,8 @@ Propel is built for developers who need to keep control of their code:
* Propel can get out of your way for when you need custom queries or hyper-optimized transactions.
* If you need to change your RDBMS in the course of the project, rebuild your model and you're ready to go. Propel supports MySQL, PostgreSQL, SQLite, MSSQL, and Oracle.
* The code generated by Propel is well commented, IDE-friendly and easy to use.
-* The Propel project started in 2005, and already powers thousands of websites. Thoroughly documented, backed by many tutorials across the web, it also benefits from an enthusiast community that provides rapid support for both beginner and hardcore developers.
+* The Propel project started in 2005, and already powers thousands of websites. Throughly documented, backed by many tutorials across the web, it also benefits from an enthusiast community that provides rapid support for both beginner and hardcore developers.
Propel is released under the [MIT license](http://www.propelorm.org/download#license). It's free to use, even in commercial applications.
-Do you want to know more? Jump to the Documentation tab, or start exploring the code in the GitHub repository.
+Do you want to know more? Jump to the Documentation tab, or start exploring the code in the [GitHub repository](https://github.com/propelorm/Propel2).
View
2  documentation/support.markdown
@@ -33,4 +33,4 @@ The [#propel](http://webchat.freenode.net/?channels=propel) channel on **irc.fre
>**Tip**<br />Since 2011, the Propel project is hosted and managed on [GitHub](http://github.com).
-You can look at the [Propel organization](https://github.com/propelorm) and to report bugs or to ask for new features to the [Propel ticketing system](https://github.com/propelorm/Propel/issues).
+You can look at the [Propel organization](https://github.com/propelorm) and to report bugs or to ask for new features to the [Propel ticketing system](https://github.com/propelorm/Propel2/issues).
Please sign in to comment.
Something went wrong with that request. Please try again.