Skip to content

Commit b0ae706

Browse files
authored
Merge pull request #5 from tigerpixel/development
Neatens readme file and changeling. Updates to beta version 0.2.0
2 parents 7b75f5a + 7afd96d commit b0ae706

File tree

4 files changed

+24
-19
lines changed

4 files changed

+24
-19
lines changed

CHANGELOG.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
Changelog
2-
=========
1+
# Changelog
32

4-
Version 0.1.0
5-
-------------
6-
*Released 2017-06-15*
3+
## Version 0.1.0
4+
5+
### *Released 2017-06-15*
76

87
* Initial beta release for Draughts game string parsing.
98
* Setup the basic project structure with Swiftlint and TravisCI.
109
* Give the project targets for iOS, Mac, tvOS and watchOS.
1110
* Make the project available to Cocoapods, Carthage and the SPM.
11+
12+
### *Released 2017-10-01*
13+
14+
* Swift 4 and Xcode 9 updates.
15+
* Swiftlint version update to 0.22.0
16+
* Add failure messages to all XCFail test cases.
17+
* Neaten markdown files.

PGNParser.podspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Pod::Spec.new do |s|
88
s.name = 'PGNParser'
9-
s.version = '0.1.0'
9+
s.version = '0.2.0'
1010
s.summary = 'A simple way to parse Portable Game Notation into Swift objects.'
1111
s.description = <<-DESC
1212
A simple way to parse Portable Game Notation into Swift objects. Easily parse game strings into Swift objects with just a single call. More work is required to fully suppourt the format. Pull requests for improvements are welcome.

PGNParser/Info.plist

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<key>CFBundlePackageType</key>
1616
<string>FMWK</string>
1717
<key>CFBundleShortVersionString</key>
18-
<string>0.1.0</string>
18+
<string>0.2.0</string>
1919
<key>CFBundleVersion</key>
2020
<string>$(CURRENT_PROJECT_VERSION)</string>
2121
<key>NSHumanReadableCopyright</key>

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
## PGNParser
1+
# PGNParser
22

33
[![Build Status](https://travis-ci.org/tigerpixel/PGNParser.svg?branch=master)](https://travis-ci.org/tigerpixel/PGNParser)
44
[![Version](https://img.shields.io/cocoapods/v/PGNParser.svg?style=flat)](http://cocoapods.org/pods/PGNParser)
55
[![Platform](https://img.shields.io/cocoapods/p/PGNParser.svg?style=flat)](http://cocoapods.org/pods/PGNParser)
66
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
77
[![License](https://img.shields.io/cocoapods/l/PGNParser.svg?style=flat)](http://cocoapods.org/pods/PGNParser)
88

9-
PGNParser is designed to parse [Portable Game Notation](https://en.wikipedia.org/wiki/Portable_Game_Notation) files describing Chess and Draughts moves into simple Swift structures.
9+
PGNParser is designed to parse [Portable Game Notation](https://en.wikipedia.org/wiki/Portable_Game_Notation) files describing Chess and Draughts moves into simple Swift structures.
1010

11-
Currently only the draughts game strings have been implemented. Pull request are welcome for further features.
11+
Currently, only the draughts game strings have been implemented. Pull requests are welcome for further features.
1212

1313
Parsing can be enacted by simply making a single call on the draughts move objects.
1414

15-
A result type will be returned which will contain the resulting move array or details of any failure.
15+
A result type will be returned which will contain the resulting move array or details of any failure.
1616

1717
A failure contains an enumeration describing the reason for the failure and usually the token which failed.
1818

19-
The following will parse to on DraughtsMove structure containing a black and a white move.
19+
The following will parse to on DraughtsMove structure containing a black and a white move.
2020

2121
```swift
2222
let sinlgeMoveTwoPlayers = "1. 9-14 23-18"
@@ -34,13 +34,12 @@ case .failure(let reason):
3434

3535
There are 2 external requirements for this project. Both by Tigerpixel, the same authors.
3636

37-
38-
[Currier](https://github.com/tigerpixel/Currier.git) - A helper for currying functions and initializers which is used with the project.
37+
[Currier](https://github.com/tigerpixel/Currier.git) - A helper for currying functions and initializers which is used with the project.
3938
[ParserCombinator](https://github.com/tigerpixel/ParserCombinator.git) - A General parser combinator which is extended to build PGNParser.
4039

4140
- iOS 8.0+ / macOS 10.9+ / tvOS 9.0+ / watchOS 2.0+
42-
- Xcode 8.2+
43-
- Swift 3.0+
41+
- Xcode 9.0+
42+
- Swift 4.0+
4443

4544
## Installation
4645

@@ -66,7 +65,7 @@ If you use Carthage to build your dependencies, make sure you have added `PGNPar
6665

6766
### Swift Package Manager
6867

69-
The [Swift Package Manager](https://swift.org/package-manager) is the official tool for managing the distribution of Swift code. It is currently available for macOS. It can also be used with Linux but this project does not fully support Linux at this point in time.
68+
The [Swift Package Manager](https://swift.org/package-manager) is the official tool for managing the distribution of Swift code. It is currently available for macOS. It can also be used with Linux but this project does not fully support Linux at this point in time.
7069

7170
If you use it to manage your dependencies, simply add PGNParser to the dependencies value of your Package.swift file.
7271

@@ -75,6 +74,7 @@ dependencies: [
7574
.Package(url: "https://github.com/Tigerpixel/PGNParser.git", majorVersion: 0)
7675
]
7776
```
77+
7878
The Swift Package Manager can resolve sub-dependencies.
7979

8080
### Git Submodule
@@ -83,8 +83,7 @@ The Swift Package Manager can resolve sub-dependencies.
8383
1. Run `git submodule update --init --recursive` from within the PGNParser folder.
8484
1. Drag and drop `PGNParser.xcodeproj` into your application’s Xcode project or workspace.
8585
1. On the “General” tab of your application target’s settings, add `PGNParser.framework`. to the “Embedded Binaries” section.
86-
1. If your application target does not contain Swift code at all, you should also
87-
set the `EMBEDDED_CONTENT_CONTAINS_SWIFT` build setting to “Yes”.
86+
1. If your application target does not contain Swift code at all, you should also set the `EMBEDDED_CONTENT_CONTAINS_SWIFT` build setting to “Yes”.
8887

8988
## MIT License
9089

0 commit comments

Comments
 (0)