Skip to content

Commit c72e057

Browse files
committed
Minor markdown style updates
1 parent b4097ff commit c72e057

File tree

4 files changed

+88
-83
lines changed

4 files changed

+88
-83
lines changed
File renamed without changes.

INSTALL.txt renamed to INSTALL.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@ INSTALLATION
33

44
Zend Framework requires no special installation steps. Simply download the framework,
55
extract it to the folder you would like to keep it in, and add the library directory
6-
to your PHP include_path. To use components in the extras library, add the extras/library
7-
directory to your PHP include_path, as well.
8-
If you would like to use Zend_Tool, simply add bin/zf.bat (for Windows) or
9-
bin/zf.sh (for anything else) to your system executable path.
6+
to your PHP `include_path`. To use components in the extras library, add the extras/library
7+
directory to your PHP `include_path`, as well.
8+
If you would like to use `Zend_Tool`, simply add `bin/zf.bat` (for Windows) or
9+
`bin/zf.sh` (for anything else) to your system executable path.
1010

1111
SYSTEM REQUIREMENTS
1212
-------------------
1313

1414
Zend Framework requires PHP 5.2.11 or later. Please see the system requirements
1515
appendix for more detailed information:
1616

17-
http://framework.zend.com/manual/en/requirements.html
17+
- http://framework.zend.com/manual/en/requirements.html
1818

1919
DEVELOPMENT VERSIONS
2020
--------------------
@@ -38,50 +38,50 @@ of the following methods:
3838

3939
The URL for the the Zend Framework 1.X git repository is:
4040

41-
https://github.com/zendframework/zf1
41+
- https://github.com/zendframework/zf1
4242

4343
For more information about git, please see the official website:
4444

45-
http://git-scm.com
45+
- http://git-scm.com
4646

4747
* Using Subversion. You may pin an svn:externals definition to our repository.
4848
For versions prior to 1.12.0, use the following URLs:
4949

50-
http://framework.zend.com/svn/framework/standard/branches/release-1.{minor version}
51-
http://framework.zend.com/svn/framework/standard/tags/release-1.{minor version}.{maintenance version}
52-
http://framework.zend.com/svn/framework/extras/branches/release-1.{minor version}
50+
- http://framework.zend.com/svn/framework/standard/branches/release-1.{minor version}
51+
- http://framework.zend.com/svn/framework/standard/tags/release-1.{minor version}.{maintenance version}
52+
- http://framework.zend.com/svn/framework/extras/branches/release-1.{minor version}
5353

5454
For versions 1.12.0 and on, use the following URLs:
5555

56-
https://github.com/zendframework/zf1/trunk (development version)
57-
https://github.com/zendframework/zf1/tags/release-1.12.{maintenance version}
58-
https://github.com/zendframework/zf1-extras/trunk
56+
- https://github.com/zendframework/zf1/trunk (development version)
57+
- https://github.com/zendframework/zf1/tags/release-1.12.{maintenance version}
58+
- https://github.com/zendframework/zf1-extras/trunk
5959

6060
For more information on subversion, please visit the official website:
6161

62-
http://subversion.apache.org/
62+
- http://subversion.apache.org/
6363

6464
CONFIGURING THE INCLUDE PATH
6565
----------------------------
6666

6767
Once you have a copy of Zend Framework available, your application will need to
6868
access the framework classes. Though there are several ways to achieve this, your
69-
PHP include_path needs to contain the path to the Zend Framework classes under the
70-
/library directory in this distribution. You can find out more about the PHP
71-
include_path configuration directive here:
69+
PHP `include_path` needs to contain the path to the Zend Framework classes under the
70+
`/library` directory in this distribution. You can find out more about the PHP
71+
`include_path` configuration directive here:
7272

73-
http://www.php.net/manual/en/ini.core.php#ini.include-path
73+
- http://www.php.net/manual/en/ini.core.php#ini.include-path
7474

7575
Instructions on how to change PHP configuration directives can be found here:
7676

77-
http://www.php.net/manual/en/configuration.changes.php
77+
- http://www.php.net/manual/en/configuration.changes.php
7878

7979
GETTING STARTED
8080
---------------
8181

8282
A great place to get up-to-speed quickly is the Zend Framework QuickStart:
8383

84-
http://framework.zend.com/docs/quickstart
84+
- http://framework.zend.com/docs/quickstart
8585

8686
The QuickStart covers some of the most commonly used components of ZF. Since
8787
Zend Framework is designed with a use-at-will architecture and components are

README-GIT.md

Lines changed: 58 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,23 @@ review.
1212

1313
### Option 1: GitHub
1414

15-
1. Setup a GitHub account (http://github.com/), if you haven't yet
16-
2. Fork the ZF1 repository (http://github.com/zendframework/zf1)
17-
3. Clone your fork locally and enter it (use your own GitHub username
18-
in the statement below)
15+
1. Setup a GitHub account (http://github.com/), if you haven't yet
16+
2. Fork the ZF1 repository (http://github.com/zendframework/zf1)
17+
3. Clone your fork locally and enter it (use your own GitHub username
18+
in the statement below)
1919

20-
```sh
21-
% git clone [email protected]:<username>/zf1.git
22-
% cd zf2
23-
```
20+
```sh
21+
% git clone [email protected]:<username>/zf1.git
22+
% cd zf2
23+
```
2424

25-
4. Add a remote to the canonical ZF repository, so you can keep your fork
26-
up-to-date:
25+
4. Add a remote to the canonical ZF repository, so you can keep your fork
26+
up-to-date:
2727

28-
```sh
29-
% git remote add zf1 https://github.com/zendframework/zf1.git
30-
% git fetch zf1
31-
```
28+
```sh
29+
% git remote add zf1 https://github.com/zendframework/zf1.git
30+
% git fetch zf1
31+
```
3232

3333
### Option 2: Personal Repository
3434

@@ -38,38 +38,38 @@ own repository. If you go this route, we will assume you have the knowledge to
3838
do so, or know where to obtain it. We will not assist you in setting up such a
3939
repository.
4040

41-
1. Create a new repository
41+
1. Create a new repository
4242

43-
```sh
44-
% git init
45-
```
43+
```sh
44+
% git init
45+
```
4646

47-
2. Add an "origin" remote pointing to your gitosis/gitolite repo:
47+
2. Add an "origin" remote pointing to your gitosis/gitolite repo:
4848

49-
```sh
50-
% git remote add origin git://yourdomain/yourrepo.git
51-
```
49+
```sh
50+
% git remote add origin git://yourdomain/yourrepo.git
51+
```
5252

53-
3. Add a remote for the ZF repository and fetch it
53+
3. Add a remote for the ZF repository and fetch it
5454

55-
```sh
56-
% git remote add zf1 https://github.com/zendframework/zf1.git
57-
% git fetch zf1
58-
```
55+
```sh
56+
% git remote add zf1 https://github.com/zendframework/zf1.git
57+
% git fetch zf1
58+
```
5959

60-
4. Create a new branch for the ZF repository (named "zf/master" here)
60+
4. Create a new branch for the ZF repository (named "zf/master" here)
6161

62-
```sh
63-
% git checkout -b zf/master zf1/master
64-
```
62+
```sh
63+
% git checkout -b zf/master zf1/master
64+
```
6565

66-
5. Create your master branch off the ZF branch, and push to your
67-
repository
66+
5. Create your master branch off the ZF branch, and push to your
67+
repository
6868

69-
```sh
70-
% git checkout -b master
71-
% git push origin HEAD:master
72-
```
69+
```sh
70+
% git checkout -b master
71+
% git push origin HEAD:master
72+
```
7373

7474
## Contributor License Agreement and your git configuration
7575

@@ -117,12 +117,12 @@ as of merging your changes into the canonical repository.
117117

118118
A typical work flow will then consist of the following:
119119

120-
1. Create a new local branch based off your master branch.
121-
2. Switch to your new local branch. (This step can be combined with the
122-
previous step with the use of `git checkout -b`.)
123-
3. Do some work, commit, repeat as necessary.
124-
4. Push the local branch to your remote repository.
125-
5. Send a pull request.
120+
1. Create a new local branch based off your master branch.
121+
2. Switch to your new local branch. (This step can be combined with the
122+
previous step with the use of `git checkout -b`.)
123+
3. Do some work, commit, repeat as necessary.
124+
4. Push the local branch to your remote repository.
125+
5. Send a pull request.
126126

127127
The mechanics of this process are actually quite trivial. Below, we will
128128
create a branch for fixing an issue in the tracker.
@@ -160,13 +160,13 @@ your repository, select the branch you just created, and then select the
160160
If using your own repository - or even if using GitHub - you can send an
161161
email indicating you have changes to pull:
162162

163-
- Send to <[email protected]>
163+
- Send to <[email protected]>
164164

165-
- In your message, specify:
166-
- The URL to your repository (e.g., `git://mwop.net/zf1.git`)
167-
- The branch containing the changes you want pulled (e.g., `zf9295`)
168-
- The nature of the changes (e.g., `implements
169-
Zend_Service_Twitter`, `fixes ZF-9295`, etc.)
165+
- In your message, specify:
166+
- The URL to your repository (e.g., `git://mwop.net/zf1.git`)
167+
- The branch containing the changes you want pulled (e.g., `zf9295`)
168+
- The nature of the changes (e.g., `implements
169+
Zend_Service_Twitter`, `fixes ZF-9295`, etc.)
170170

171171
### What branch to issue the pull request against?
172172

@@ -186,24 +186,23 @@ get a ton of branches both locally and on your remote.
186186
Once you know that your changes have been accepted to the master
187187
repository, we suggest doing some cleanup of these branches.
188188

189-
- Local branch cleanup
189+
- Local branch cleanup
190190

191-
```sh
192-
% git branch -d <branchname>
193-
```
194-
195-
- Remote branch removal
191+
```sh
192+
% git branch -d <branchname>
193+
```
196194

197-
```sh
198-
% git push origin :<branchname>
199-
```
195+
- Remote branch removal
200196

197+
```sh
198+
% git push origin :<branchname>
199+
```
201200

202201
## FEEDS AND EMAILS
203202

204203
RSS feeds may be found at:
205204

206-
`https://github.com/zendframework/zf1/commits/<branch>.atom`
205+
- `https://github.com/zendframework/zf1/commits/<branch>.atom`
207206

208207
where &lt;branch&gt; is a branch in the repository.
209208

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ http://framework.zend.com/manual/en/requirements.html
211211
INSTALLATION
212212
============
213213

214-
Please see [INSTALL.txt](INSTALL.txt).
214+
Please see [INSTALL.md](INSTALL.md).
215215

216216
REPOSITORY HISTORY
217217
==================
@@ -223,25 +223,31 @@ and only contains the tags for the 1.12 series. If you would like an older
223223
version, you may access the subversion repository linked above, or download an
224224
older version from http://framework.zend.com/downloads/archives.
225225

226+
CONTRIBUTING
227+
============
228+
229+
Please see [README-GIT.md](README-GIT.md) and
230+
[DEVELOPMENT_README.md](DEVELOPMENT_README.md).
231+
226232
QUESTIONS AND FEEDBACK
227233
======================
228234

229235
Online documentation can be found at http://framework.zend.com/manual.
230236
Questions that are not addressed in the manual should be directed to the
231237
appropriate mailing list:
232238

233-
http://framework.zend.com/wiki/display/ZFDEV/Mailing+Lists
239+
- http://framework.zend.com/wiki/display/ZFDEV/Mailing+Lists
234240

235241
If you find code in this release behaving in an unexpected manner or
236242
contrary to its documented behavior, please create an issue in the Zend
237243
Framework issue tracker at:
238244

239-
http://framework.zend.com/issues
245+
- https://github.com/zendframework/zf1/issues
240246

241247
If you would like to be notified of new releases, you can subscribe to
242248
the fw-announce mailing list by sending a blank message to:
243249

244-
250+
245251

246252
LICENSE
247253
=======

0 commit comments

Comments
 (0)