From 93cff615c378425ca5895df25c562fe286c893d3 Mon Sep 17 00:00:00 2001 From: Louis DeJardin Date: Thu, 23 Jan 2014 20:24:02 -0800 Subject: [PATCH] Create README.md --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000..4f91fa27d8 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +Universe +======== + +Getting started + + git clone git@github.com:aspnet/Universe.git + cd Universe + build + +The default build will clone all known repos as subfolders. The clone will be the dev branch. + +If the build is run subsequently it will `git pull` the dev branch rather than clone. Note! This will cause a +merge if you have local changes. We may tweak how this is done if it causes problems. + +After folders are up to date, `build.cmd compile` is executed in each of the enlisted subfolders. + +If there are errors the build will continue with the next repo. + +The last output is a list of which repos succeeded or failed. + +## build targets + +`build pull` will only clone or pull all repos. + +`build compile` this is the default target, described above. + +`build install` works like build compile, but will run `build.cmd install` in each subfolder. This means +any nupkg produced by the repo are copied into the local `.nuget` folder to be picked up by subsequent +repositories. The subfolders are built in dependency order. +