wayfair / vsm-ios

An iOS framework for the VSM Architecture
MIT License
9 stars 2 forks source link

Quickstart Rewrite #15

Closed albertbori closed 1 year ago

albertbori commented 1 year ago

Description

This PR replaces the old QuickstartGuide.md with a new Xcode+DocC QuickstartGuide.tutorial and all of its bells and whistles. This PR also spruces up the project's readme file with some suuuper high-level snippets to give a general idea of what VSM looks like.

The reworked QuickstartGuide.tutorial article is best viewed from the Xcode Documentation Browser. Clone the branch, open Xcode, and build the documentation (Cmd + Ctrl + Shift + D)

You'll notice that there are many, slightly different code files. Don't be alarmed, and don't read them as-is in the repository. Those are auto-diffed by the DocC tutorial engine to show as a single file with code highlighted between steps. So the best way to review those is to build the documentation in Xcode and view it in the docs viewer.

Type of Change