-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Fernando Martín García Del Angel
authored
Feb 20, 2020
1 parent
6748e03
commit b345946
Showing
1 changed file
with
47 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,47 @@ | ||
FlinkChallenge | ||
# 🚲 FlinkChallenge - The Flink Challenge App | ||
|
||
A companion project to the | ||
[NSHipster article about Swift Documentation](https://nshipster.com/swift-documentation/). | ||
|
||
## Requirements | ||
|
||
- Xcode | ||
- Git 2.16.2+ | ||
- Ruby 2.4.3+ | ||
- [Cocoapods](https://cocoapods.org) | ||
|
||
## Generating Docs | ||
|
||
First, clone the repository by opening Terminal.app | ||
and running the following commands: | ||
|
||
```terminal | ||
$ git clone [email protected]:A01334390/FlinkChallenge.git | ||
$ cd FlinkChallenge | ||
$ cd FlinkChallenge | ||
``` | ||
|
||
Next, download project dependencies with CocoaPods using the command: | ||
|
||
```terminal | ||
$ pod install | ||
``` | ||
|
||
Use [Jazzy](https://github.com/realm/jazzy) | ||
to generate web pages from the documentation comments of this Swift project: | ||
|
||
```terminal | ||
$ bundle exec jazzy -o Docs | ||
``` | ||
|
||
Now open the `index.html` from the `Docs` directory | ||
to view the generated documentation: | ||
|
||
```terminal | ||
$ open Docs/index.html | ||
``` | ||
|
||
## License | ||
|
||
This project is released under a Copyright (C) 2020 Fernando Martin Garcia Del Angel License | ||
See the LICENSE file for more info. |