From 4fcf544abe6538bce829a70060e4aaad98c63f59 Mon Sep 17 00:00:00 2001
From: dannyrb <danny.ri.brown@gmail.com>
Date: Mon, 15 Jul 2019 15:51:24 -0400
Subject: [PATCH] Begin providing basic readme info

---
 README.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 76 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 099dd347c..873e5f72c 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,69 @@
 # OHIF Medical Imaging Platform
 
-```bash
-# Flip workspaces flag
-yarn config set workspaces-experimental true
+## The Problem
 
+...
+
+## Why Choose Us
+
+...
+
+## Quick Start
+
+...
+
+## Developing
+
+The OHIF Medical Image Viewing Platform is maintained as a
+[`monorepo`][monorepo]. This means that this repository, instead of containing a
+single project, contains many projects. If you explore our project structure,
+you'll see the following:
+
+```bash
+.
+├── extensions              #
+│   ├── _example            # Skeleton of example extension
+│   ├── cornerstone         # 2D images w/ Cornerstone.js
+│   ├── dicom-html          # Structured Reports as HTML in viewport
+│   ├── dicom-microscopy    # Whole slide microscopy viewing
+│   ├── dicom-pdf           # View DICOM wrapped PDFs in viewport
+│   └── vtk                 # MPR and Volume support w/ VTK.js
+│
+├── platform                #
+│   ├── core                # Business Logic
+│   ├── i18n                # Internationalization Support
+│   ├── ui                  # React component library
+│   └── viewer              # Connects platform and extension projects
+│
+├── ...                     # misc. shared configuration
+├── lerna.json              # MonoRepo (Lerna) settings
+├── package.json            # Shared devDependencies and commands
+└── README.md               # This file
+```
+
+Want to better understand why and how we've structured this repository? Read
+more about it in our [Architecture Documentation](#todo).
+
+### Requirements
+
+- [Yarn 1.17.3+](https://yarnpkg.com/en/docs/install)
+- [Node 8+](https://nodejs.org/en/)
+- Yarn Workspaces should be enabled on your machine:
+  - `yarn config set workspaces-experimental true`
+
+### Getting Started
+
+1. [Fork this repository][how-to-fork]
+1. [Clone your forked repository][how-to-clone]
+   - `git clone https://github.com/YOUR-USERNAME/Viewers.git`
+1. Navigate to the cloned project's directory
+1. Add this repo as a `remote` named `upstream`
+   - `git remote add upstream https://github.com/OHIF/Viewers.git`
+1. `yarn install` to restore dependencies and link projects
+
+#### To Develop
+
+```bash
 # Force install
 yarn install --force
 
@@ -43,3 +103,16 @@ PWA builds go through
 > node. This enables webpack to parse the module syntax itself, allowing for
 > lighter bundles via tree shaking if users are only consuming certain parts of
 > the library.
+
+<!--
+  Links
+  -->
+
+<!-- prettier-ignore-start -->
+
+[monorepo]: https://en.wikipedia.org/wiki/Monorepo
+[how-to-fork]: https://help.github.com/en/articles/fork-a-repo
+[how-to-clone]: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork
+
+
+<!-- prettier-ignore-end -->