/theswiftbook

Let's write a book about Swift, together!

MIT LicenseMIT

The Swift Book

The first open-source Swift book, viewed and editable by everyone!

Start Reading

Head over to this link to read the book in a format that best fits your device.

Goal & Vision

To create an open-source book, about Swift!

Swift is an ever changing language and to be able to stay on top of these changes, we need a new way of writing content. One author cannot keep a whole book always up to date with new Swift content, so why not leverage the power of GitHub and write it together?

GitHub already gives us many of the tools that we need:

  • Ability to write rich text, in Markdown
  • The ability for readers to raise issues through the built-in issue tracking system
  • Pull requests, allowing contributors provide new/updated content
  • Releases, which will allow us to release official updates of this book, every now and then
  • The distributed nature of Git, that allows contributors to write and update content, wherever they are and whenever they wish

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Report any abuse of the code of conduct to crowdsourcebooks@gmail.com

Writing New Content, Fixing Issues

This book is entirely made out of Markdown files (MD) and PNG images for figures. There are code snippets as well which will be inside the text itself.

Follow these steps in order to send your content to The Swift Book:

  • You need to do this once:
    • Fork this repository
    • Go to GitBook and log in with your GitHub account
      • Select SIGN IN button
      gitbook_sign_in_annotated * Log in to your account gitbook_log_in * Choose `Create or Import your first book` button gitbook_create_new_book_annotated * Link to your GitHub gitbook_link_to_github_annotated * Add your forked repo to your GitBook account gitbook_select_repository_annotated
    • Download the GitBook editor on your Mac
  • Work on your changes with GitBook editor, and commit them to your fork
  • Send a pull request for review to the master repo

Note: This book will be published through GitBook, so to write content and contribute to this repo, it's best that you use GitBook's native editor app on your Mac.