From cce393f359127a4ecab981e2a26292befef26246 Mon Sep 17 00:00:00 2001
From: Adam Samalik <asamalik@redhat.com>
Date: Jul 28 2018 12:50:44 +0000
Subject: add readme


---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..82ad1f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Fedora Modularity Docs
+
+Please report Issues and submit Pull Requests for **Content Fixes** here.
+Never done a pull request (or "PR")? Here's the [Pagure documentation for
+Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html).
+
+
+General appearance issues and publishing issues should be reported against
+the [publishing software](https://pagure.io/fedora-docs/docs-fp-o).
+
+## How to edit these documents
+
+All of this is written in AsciiDoc. It's a simple mostly-plain-text
+markup language. You may want to look at:
+
+
+* [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
+* [AsciiDoc Writer’s  Guide](http://asciidoctor.org/docs/asciidoc-writers-guide/)
+* [Antora Documentation](https://docs.antora.org/antora/1.0/page/)
+
+
+## Local preview
+
+This repo includes scripts to build and preview the contents of this repository.
+
+**NOTE**: Please note that if you reference pages from other repositoreis, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.
+
+Both scripts use docker, so please make sure you have it installed on your system. Please see below for instructions.
+
+To build and preview the site, run:
+
+```
+$ ./build.sh && ./preview.sh
+```
+
+The result will be available at http://localhost:8080
+
+### Installing docker on Fedora
+
+```
+$ sudo dnf install docker
+$ sudo systemctl start docker && sudo systemctl enable docker
+```
diff --git a/install-guide b/install-guide
new file mode 160000
index 0000000..f3c38d8
--- /dev/null
+++ b/install-guide
@@ -0,0 +1 @@
+Subproject commit f3c38d8d4f5f6610365172b288e536aba3b6b63c