Skip to content

Commit 5fdb9b9

Browse files
committed
Converted some read me files from RTF to markdown. Updated the release instructions for GitHub.
1 parent 3945966 commit 5fdb9b9

8 files changed

Lines changed: 95 additions & 236 deletions

‎READMEs/README for Docs Install.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# To Install Documentation From a Release Package
2+
3+
1. Quit Xcode.
4+
5+
2. Copy the **com.CorePlot.Framework.docset** and/or **com.CorePlotTouch.Framework.docset** bundles from the release Documentation folder into **~/Library/Developer/Shared/Documentation/DocSets/**.
6+
7+
3. Launch Xcode and browse the Core Plot documentation in the Documentation browser.
8+
9+
# To Build the Documentation From Source
10+
11+
1. Install [Doxygen]([http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc) in **/Applications**. Core Plot requires Doxygen 1.7.4 or later.
12+
13+
2. Install [Graphviz](http://www.graphviz.org/Download_macos.php). Core Plot requires Graphviz 2.28.0 or later.
14+
15+
3. Open the **CorePlot** or **CorePlot-CocoaTouch** project in Xcode.
16+
17+
4. Build the "Documentation" target.

‎READMEs/README for Docs Install.rtf‎

Lines changed: 0 additions & 42 deletions
This file was deleted.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Install Binaries for iOS
2+
3+
1. Copy the **CorePlotHeaders** to your Xcode project
4+
5+
2. Copy **libCorePlotCocoaTouch.a** to your Xcode project
6+
7+
3. Add the following flags to "Other Linker Flags" in your target build settings:
8+
`-ObjC -all_load`
9+
10+
4. Add the **QuartzCore** framework to the project.
11+
12+
5. Add a `CPTGraph` to your application. See the example apps in Source Code to see how, or read the documentation.

‎READMEs/README for Static Library Install.rtf‎

Lines changed: 0 additions & 32 deletions
This file was deleted.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Follow these steps to format the Core Plot code to conform with the coding guidelines.
2+
3+
1. Ensure [Uncrustify](http://uncrustify.sourceforge.net/), version 0.60 or later, is installed installed in **/usr/local/bin**.
4+
5+
2. Open the Terminal application and `cd` to the root directory of your local Core Plot source directory.
6+
7+
3. Change to the **scripts** folder:
8+
`$ cd scripts`
9+
10+
4. Run the **format_core_plot** script:
11+
`$ ./format_core_plot.sh`

‎scripts/README Automatic code formatting.rtf‎

Lines changed: 0 additions & 38 deletions
This file was deleted.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
Follow these steps to create a Core Plot release and post it to GitHub:
2+
3+
1. Ensure the following tools are installed on your development machine:
4+
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
8+
9+
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.
10+
11+
3. Using Git, ensure your local Core Plot source directory is in sync with the public repository on GitHub.
12+
13+
4. Open the Terminal application and `cd` to the root directory of your local Core Plot source directory.
14+
15+
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+
6. Change to the **scripts** folder:
20+
`$ cd scripts`
21+
22+
7. Run the createrelease script:
23+
`$ python createrelease.py <version>`
24+
25+
8. Review the messages printed in the Terminal window and verify that all build steps succeeded.
26+
27+
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:
28+
29+
* **Binaries/iOS/**
30+
* **Binaries/MacOS/**
31+
* **Documentation/**
32+
* **READMEs/**
33+
* **Source/**
34+
* **License.txt**
35+
36+
10. Right-click the release folder on your desktop and select **Compress "&lt;filename&gt;"** from the menu.
37+
38+
11. Log into GitHub and navigate to the [Releases](https://github.com/core-plot/core-plot/releases) page.
39+
40+
12. Click **Draft a new release**.
41+
42+
13. Select the tag for the new release (`release_<version>`).
43+
Enter the following:
44+
45+
* Release title: **Core Plot Release &lt;version&gt;**
46+
* Binaries: drag the Core Plot zip file on your desktop to the box
47+
48+
14. Click **Publish release**.
49+
50+
15. Change to the HTML documentation directory cloned from [https://github.com/core-plot/core-plot.github.io]():
51+
`cd ../documentation/html`
52+
53+
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.

‎scripts/README Creating a release package.rtf‎

Lines changed: 0 additions & 124 deletions
This file was deleted.

0 commit comments

Comments
 (0)