diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 0000000..38f2a69 --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,2 @@ +If you have not previously done so, please fill out and +submit the https://cla.pivotal.io/sign/pivotal[Contributor License Agreement]. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 66528f0..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,2 +0,0 @@ -If you have not previously done so, please fill out and -submit the [Contributor License Agreement](https://cla.pivotal.io/sign/pivotal). diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..ad184ef --- /dev/null +++ b/README.adoc @@ -0,0 +1,42 @@ +:toc: preamble +:toclevels: 2 +:!toc-title: +:linkattrs: + += Steeltoe Tooling + +Steeltoe developer tool collection + +== Testing + +.Run unit test suite +---- +> scripts/unit-test + +# Alternatively +> dotnet test test/Steeltoe.Tooling.Test +---- + +.Run CLI test suite +---- +> scripts/cli-test + +# Alternatively +> dotnet test test/Steeltoe.Cli.Test +---- + +== Install/Uninstall + +.Install +---- +> scripts/install + +# Alternatively +> dotnet pack +> dotnet tool install -g --add-source src/Steeltoe.Cli/bin/Debug Steeltoe.Cli +---- + +.Uninstall +---- +> dotnet tool uninstall -g Steeltoe.Cli +---- diff --git a/README.md b/README.md deleted file mode 100644 index 63fc002..0000000 --- a/README.md +++ /dev/null @@ -1,51 +0,0 @@ -# Steeltoe Tooling - -Steeltoe developer tool collection. - -For documentation, please see the [Steeltoe Tooling Wiki](https://github.com/SteeltoeOSS/Tooling/wiki). - -## Latest Builds - -Platform | Branch | Status --------- | ------ | ------ -Windows | master | [![AppVeyor master status](https://ci.appveyor.com/api/projects/status/bpwhsnue8j7iiwpp/branch/master?svg=true)](https://ci.appveyor.com/project/steeltoe/tooling/branch/master) -Windows | dev | [![AppVeyor dev status](https://ci.appveyor.com/api/projects/status/bpwhsnue8j7iiwpp/branch/dev?svg=true)](https://ci.appveyor.com/project/steeltoe/tooling/branch/dev) -Linux/OS X | master | [![Travis CI master status](https://travis-ci.org/SteeltoeOSS/Tooling.svg?branch=master)](https://travis-ci.org/SteeltoeOSS/Tooling) -Linux/OS X | dev | [![Travis CI dev status](https://travis-ci.org/SteeltoeOSS/Tooling.svg?branch=dev)](https://travis-ci.org/SteeltoeOSS/Tooling) - -## Developer Chores - -### Testing - -Run unit test suites: -``` -> scripts/unit-test - -# Alternatively -> dotnet test test/Steeltoe.Tooling.Test -``` - -Run CLI test suites (takes several minutes): -``` -> scripts/cli-test - -# Alternatively -> dotnet test test/Steeltoe.Cli.Test -``` - -### Install into .NET Global Tools - -Install: -``` -> scripts/install - -# Alternatively -> dotnet pack -> dotnet tool install -g --add-source src/Steeltoe.Cli/bin/Debug Steeltoe.Cli -``` - -Uninstall: -``` -> dotnet tool uninstall -g Steeltoe.Cli -``` - diff --git a/builds.adoc b/builds.adoc new file mode 100644 index 0000000..53b2866 --- /dev/null +++ b/builds.adoc @@ -0,0 +1,15 @@ +:linkattrs: +:branch: dev +:uri-build-windows: https://ci.appveyor.com/project/steeltoe/tooling/branch/dev +:uri-status-windows: https://ci.appveyor.com/api/projects/status/github/SteeltoeOSS/Tooling +:uri-build-linuxosx: https://travis-ci.org/SteeltoeOSS/Tooling +:uri-status-linuxosx: {uri-build-linuxosx} + += Steeltoe Tooling Builds: `{branch}` Branch + +|=== +| Platform | Status + +| Windows | image:{uri-status-windows}?svg=true&branch={branch}["Windows Build Status", link={uri-build-windows}] +| Linux/OS X | image:{uri-status-linuxosx}.svg?branch={branch}["Linux/OS X Build Status", link={uri-build-linuxosx}] +|===