Skip to content

Commit 1f5e8a0

Browse files
committed
Document how to build LispKit from scratch.
1 parent f5857fd commit 1f5e8a0

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<img src="Assets/lispkit_logo_small.png" alt="LispKit" width="80" height="80" align="middle" />&nbsp;Swift LispKit
2-
======================================================
32

4-
[![Platform: macOS](https://img.shields.io/badge/Platform-macOS-blue.svg?style=flat)](https://developer.apple.com/osx/)]
3+
[![Platform: macOS](https://img.shields.io/badge/Platform-macOS-blue.svg?style=flat)](https://developer.apple.com/osx/)
54
[![Language: Swift 3.1](https://img.shields.io/badge/Language-Swift%203.1-green.svg?style=flat)](https://developer.apple.com/swift/)
65
[![IDE: Xcode 8.3](https://img.shields.io/badge/IDE-Xcode%208.3-orange.svg?style=flat)](https://developer.apple.com/xcode/)
76
[![Carthage: compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
@@ -74,15 +73,39 @@ the entered _LispKit_ expression, compiles it to bytecode, executes it, and
7473
displays the result.
7574

7675

77-
## Dependencies
76+
## Building and running the read-eval-print loop
7877

79-
_LispKit_ relies on [NumberKit](http://github.com/objecthub/swift-numberkit)
80-
for its support of numeric datatypes like rationals, complex numbers, and big integers.
78+
First, clone the _LispKit_ repository via `git`. This will create a directory `swift-lispkit`.
8179

80+
```sh
81+
> git clone https://github.com/objecthub/swift-lispkit.git
82+
Cloning into 'swift-lispkit'...
83+
remote: Counting objects: 1849, done.
84+
remote: Compressing objects: 100% (39/39), done.
85+
remote: Total 1849 (delta 9), reused 0 (delta 0), pack-reused 1806
86+
Receiving objects: 100% (1849/1849), 689.43 KiB | 666.00 KiB/s, done.
87+
Resolving deltas: 100% (1430/1430), done.
88+
```
89+
90+
Next, fetch dependencies and build them from scratch via `carthage`:
91+
```sh
92+
> cd swift-lispkit
93+
> carthage bootstrap
94+
*** Checking out swift-numberkit at "1.6.0"
95+
*** xcodebuild output can be found in /var/folders/c_/h31lvvtx72s3zhc9bvxd0p480000gn/T/carthage-xcodebuild.46W8Z7.log
96+
*** Building scheme "NumberKit (shared)" in NumberKit.xcodeproj
97+
```
98+
99+
Now, it's possible to switch to Xcode and build the read-eval-print loop via
100+
scheme `LispKitRepl`:
101+
```sh
102+
> open LispKit.xcodeproj
103+
```
82104

83105
## Requirements
84106

85107
- XCode 8.3
108+
- [Carthage](https://github.com/Carthage/Carthage)
86109
- Swift 3.1
87110
- [NumberKit](http://github.com/objecthub/swift-numberkit)
88111

0 commit comments

Comments
 (0)