Skip to content

ebelinski/iosref

Repository files navigation

iOS Ref

iOS Ref serves as a one-stop quick reference spot for iOS, iPadOS, watchOS, and tVOS developers. It is built with Jekyll and deployed on GitHub Pages. Changes merged into the main branch are automatically deployed.

Getting started

To make contributions, you can submit pull requests with changes to the relevant markdown files. However, if you would like to build the iOS Ref website locally, follow these instructions:

  1. Install the correct version of Ruby, ideally using a tool such as rbenv.
  2. Install the project Ruby dependencies: bundle install.
  3. Start the local Jekyll server: bundle exec jekyll serve.

The website should now be visible in a browser at http://127.0.0.1:4000/.

Contributing

You may open issues for suggestions and pull request for proposed changes. All contributors must follow the code of conduct. Any contributions you make must follow the license.

License

This repository has two licenses. The MIT License, a software license, covers the whole repository except for the _subpages folder, which contains the content pages. The Attribution-ShareAlike 4.0 International license, a content license, covers the _subpages folder, as well as the contents visible on the website itself. See LICENSE.md for more information.