Skip to content

Commit 90f8067

Browse files
committed
Update README Creating a release package.md
1 parent fcf9e2c commit 90f8067

1 file changed

Lines changed: 34 additions & 20 deletions

File tree

scripts/README Creating a release package.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@ Follow these steps to create a Core Plot release and post it to GitHub:
22

33
1. Ensure the following tools are installed on your development machine:
44

5-
* Xcode 5
6-
* [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc), version 1.7.4 or later, installed in **/Applications**
7-
* [Graphviz](http://www.graphviz.org/Download_macos.php), version 2.28.0 or later
5+
<ul>
6+
<li>Xcode 5</li>
7+
<li>[Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc), version 1.8.6 or later, installed in <strong>/Applications</strong></li>
8+
<li>[Graphviz](http://www.graphviz.org/Download_macos.php), version 2.34.0 or later</li>
9+
</ul>
810

911
2. Ensure the [change log](https://github.com/core-plot/core-plot/blob/master/documentation/changelog.markdown) is up-to-date and committed to the Git repository.
1012

@@ -13,25 +15,31 @@ Follow these steps to create a Core Plot release and post it to GitHub:
1315
4. Open the Terminal application and `cd` to the root directory of your local Core Plot source directory.
1416

1517
5. Tag the current revision with the release version:
16-
`$ git tag release_<version>`
17-
where &lt;version&gt; is the version number for this release.
18+
19+
`$ git tag release_<version>`
20+
21+
where **&lt;version&gt;** is the version number for this release.
1822

1923
6. Change to the **scripts** folder:
20-
`$ cd scripts`
24+
25+
`$ cd scripts`
2126

2227
7. Run the createrelease script:
23-
`$ python createrelease.py <version>`
28+
29+
`$ python createrelease.py <version>`
2430

2531
8. Review the messages printed in the Terminal window and verify that all build steps succeeded.
2632

2733
9. The release products were placed in a folder called **CorePlot_&lt;version&gt;** and placed on your desktop. Open this folder and verify that the following subfolders and files are present:
2834

29-
* **Binaries/iOS/**
30-
* **Binaries/MacOS/**
31-
* **Documentation/**
32-
* **READMEs/**
33-
* **Source/**
34-
* **License.txt**
35+
<ul>
36+
<li><strong>Binaries/iOS/</strong></li>
37+
<li><strong>Binaries/MacOS/</strong></li>
38+
<li><strong>Documentation/</strong></li>
39+
<li><strong>READMEs/</strong></li>
40+
<li><strong>Source/</strong></li>
41+
<li><strong>License.txt</strong></li>
42+
</ul>
3543

3644
10. Right-click the release folder on your desktop and select **Compress "&lt;filename&gt;"** from the menu.
3745

@@ -40,16 +48,22 @@ Follow these steps to create a Core Plot release and post it to GitHub:
4048
12. Click **Draft a new release**.
4149

4250
13. Select the tag for the new release (`release_<version>`).
43-
Enter the following:
4451

45-
* Release title: **Core Plot Release &lt;version&gt;**
46-
* Binaries: drag the Core Plot zip file on your desktop to the box
52+
Enter the following:
4753

54+
<ul>
55+
<li>Release title: <strong>Core Plot Release &lt;version&gt;</strong></li>
56+
<li>Binaries: drag the Core Plot zip file on your desktop to the box</li>
57+
</ul>
58+
4859
14. Click **Publish release**.
4960

50-
15. Change to the HTML documentation directory cloned from [https://github.com/core-plot/core-plot.github.io]():
51-
`cd ../documentation/html`
61+
15. Change to the HTML documentation directory cloned from [core-plot.github.io](https://github.com/core-plot/core-plot.github.io):
62+
63+
`cd ../documentation/html`
5264

5365
16. Tag the current revision with the release version:
54-
`$ git tag release_<version>`
55-
where &lt;version&gt; is the version number for this release.
66+
67+
`$ git tag release_<version>`
68+
69+
where **&lt;version&gt;** is the version number for this release.

0 commit comments

Comments
 (0)