From 3a27e0a239fd4a1fbd4bc314dc71bfe1e3b34aa1 Mon Sep 17 00:00:00 2001 From: Alistair Chapman Date: Sat, 6 May 2017 01:33:00 +1000 Subject: [PATCH] Minor documentation updates --- README.md | 16 ++++++++++++++++ docfx/index.md | 19 +++++++++++++++---- docfx/toc.yml | 1 + package/README.md | 0 tools/packages.config | 2 +- 5 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 README.md delete mode 100644 package/README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d13c41f --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# ClickTwice +# The ultimate WPF build toolchain + +## Introduction + +As the name implies, ClickTwice is the missing step from the ClickOnce deployment technology. ClickTwice allows you to decouple your build and deploy steps from Visual Studio, instead integrating them with your preferred build environment. Currently, three environments are supported: + +- Cake build scripts +- ScriptCs scripts +- Self-hosting (custom tool) + +ClickTwice doesn't just build and publish your app: it also provides a powerful framework for pre- and post-processing your application at publish-time, allowing for a wide range of new abilities as pluggable handlers. + +## Getting Started + +ClickTwice is usually run by a *"host"*, a context to help control and configure ClickTwice itself. Out-of-the-box, the easiest way to get started is by using the Cake or ScriptCs host. Alternatively, you can self-host the toolchain to get more fine-tuned control over the build. Plus, since it's all just .NET, you can integrate the toolchain directly into your own applications. \ No newline at end of file diff --git a/docfx/index.md b/docfx/index.md index d2e2436..d13c41f 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -1,5 +1,16 @@ +# ClickTwice +# The ultimate WPF build toolchain -# This is the **HOMEPAGE**. -Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. -## Quick Start Notes: -1. Add images to *images* folder if the file is referencing an image. +## Introduction + +As the name implies, ClickTwice is the missing step from the ClickOnce deployment technology. ClickTwice allows you to decouple your build and deploy steps from Visual Studio, instead integrating them with your preferred build environment. Currently, three environments are supported: + +- Cake build scripts +- ScriptCs scripts +- Self-hosting (custom tool) + +ClickTwice doesn't just build and publish your app: it also provides a powerful framework for pre- and post-processing your application at publish-time, allowing for a wide range of new abilities as pluggable handlers. + +## Getting Started + +ClickTwice is usually run by a *"host"*, a context to help control and configure ClickTwice itself. Out-of-the-box, the easiest way to get started is by using the Cake or ScriptCs host. Alternatively, you can self-host the toolchain to get more fine-tuned control over the build. Plus, since it's all just .NET, you can integrate the toolchain directly into your own applications. \ No newline at end of file diff --git a/docfx/toc.yml b/docfx/toc.yml index ecd999f..445c248 100644 --- a/docfx/toc.yml +++ b/docfx/toc.yml @@ -1,6 +1,7 @@ - name: Documentation href: doc/ + homepage: doc/intro.md - name: API Reference href: api/ homepage: api/index.md diff --git a/package/README.md b/package/README.md deleted file mode 100644 index e69de29..0000000 diff --git a/tools/packages.config b/tools/packages.config index 9bd7e2c..71a0ffa 100644 --- a/tools/packages.config +++ b/tools/packages.config @@ -1,4 +1,4 @@ - + \ No newline at end of file