Skip to content

Commit

Permalink
Add a proper readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
katoemba committed Dec 27, 2019
1 parent 0a7d8a0 commit 9d8f683
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
@@ -1,3 +1,36 @@
# libmpdclient
# libmpdclient-swift

This is a variant of libmpdclient for use inside a swift application. It's functionally the same as [libmpdclient](https://github.com/MusicPlayerDaemon/libmpdclient),
with changes to the directory structure to turn it into a swift package.

## Requirements

* Xcode 11
* Swift 5.0

## Installation

libmpdclient-swift doesn't contain any external dependencies.

Currently only build and usage via swift package manager is supported:

### [Swift Package Manager](https://github.com/apple/swift-package-manager)

The easiest way to add the library is directly from within XCode (11). Alternatively you can create a `Package.swift` file.

```swift
// swift-tools-version:5.0

import PackageDescription

let package = Package(
name: "MyProject",
dependencies: [
.package(url: "https://github.com/katoemba/libmpdclient-swift.git", from: "0.21.17")
],
targets: [
.target(name: "MyProject", dependencies: ["libmpdclient"])
]
)
```

A description of this package.
2 changes: 2 additions & 0 deletions libmpdclient.xcodeproj/project.pbxproj
Expand Up @@ -155,6 +155,7 @@
C543F6222346734E00E5CE84 /* ierror.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = ierror.h; sourceTree = "<group>"; };
C543F6232346734F00E5CE84 /* isend.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = isend.h; sourceTree = "<group>"; };
C543F6242346734F00E5CE84 /* internal.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = internal.h; sourceTree = "<group>"; };
C5C6CB5623B5F72E00767B41 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
C5F9176123B57E1300AD044D /* partition.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; path = partition.c; sourceTree = "<group>"; };
C5F9176223B57E1300AD044D /* cpartition.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; path = cpartition.c; sourceTree = "<group>"; };
C5F9176323B57E1300AD044D /* binary.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = binary.h; sourceTree = "<group>"; };
Expand Down Expand Up @@ -234,6 +235,7 @@
OBJ_5 = {
isa = PBXGroup;
children = (
C5C6CB5623B5F72E00767B41 /* README.md */,
OBJ_6 /* Package.swift */,
OBJ_7 /* Sources */,
OBJ_60 /* Tests */,
Expand Down

0 comments on commit 9d8f683

Please sign in to comment.