Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Dev docs] How to develop with Texture #1538

Merged
merged 7 commits into from
Jun 11, 2019
Merged

[Dev docs] How to develop with Texture #1538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cf9028c
[Dev docs] How to develop with Texture
nguyenhuy Jun 4, 2019
9c90e46
Update how-to-develop.md
nguyenhuy Jun 4, 2019
e9e9dae
Update how-to-develop.md
nguyenhuy Jun 4, 2019
ff036d9
Update how-to-develop.md
nguyenhuy Jun 4, 2019
9fd29e0
Update how-to-develop.md
nguyenhuy Jun 4, 2019
a212ae4
Address comment
nguyenhuy Jun 4, 2019
2843203
Address comments
nguyenhuy Jun 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions docs/_docs/development/how-to-develop-and-debug.md
View file
Open in desktop

This file was deleted.

15 changes: 15 additions & 0 deletions docs/_docs/development/how-to-develop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: How to start contributing to Texture
layout: docs
permalink: /development/how-to-develop.html
---

As an open source project, contributions are always welcome. Before you start, please read our <a href = "https://github.com/TextureGroup/Texture/blob/master/CONTRIBUTING.md">Contribution Guidelines</a>. It's also a good idea to familiarize yourself with our <a href = "overview.html">Development documentations</a>.

Setting up your dev environment:
- If you don't have CocoaPods installed on your machine yet, you should <a href = "https://guides.cocoapods.org/using/getting-started.html#getting-started">install it</a> now.
- Clone the framework's source code to your machine: `git clone git@github.com:TextureGroup/Texture.git` or `git clone https://github.com/TextureGroup/Texture.git`.
- Run `pod install` in the directory that you cloned to.
- Open "AsyncDisplayKit.xcworkspace" file CocoaPods has just generated. The workspace includes all the source code, as well as our test suite.
- To run the test suite, make sure you select the same <a href = "https://github.com/TextureGroup/Texture/blob/32a2ebf49b797b0ba2a74f2af44457a9aa7b1160/build.sh#L3">device configuration we are using for our CI</a>, which is an iPhone 7 running iOS 10.2. This is important as our snapshot tests only have snapshots captured on such device configuration.
- To run one of our sample projects, run `pod install` in the sample's directory and open the generated workspace.