From 7d7d87b57ba4e05f1997779860e1172e5c09e31e Mon Sep 17 00:00:00 2001 From: Dan Anglin Date: Mon, 22 May 2023 07:52:28 +0100 Subject: [PATCH] doc: rewrite README with asciidoc --- README.asciidoc | 46 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 40 ---------------------------------------- 2 files changed, 46 insertions(+), 40 deletions(-) create mode 100644 README.asciidoc delete mode 100644 README.md diff --git a/README.asciidoc b/README.asciidoc new file mode 100644 index 0000000..cccbd23 --- /dev/null +++ b/README.asciidoc @@ -0,0 +1,46 @@ += Greetings + +== Summary + +Greet is a simple Go CLI application that greets a recipient. +This is a simple project used for the purpose of testing upcoming automation, +such as CI/CD integration and dependency management, which will be used by other projects +hosted in Code Flow. + +== Project's Avatar + +The project's avatar was made by https://www.flaticon.com/authors/smashicons[Smashicons] from https://www.flaticon.com[Flaticon]. + +== Requirements + +- https://go.dev[Go] + +== Build + +[source,console] +---- +$ go build -o greet . +---- + +== Run + +Greet the world. + +[source,console] +---- +$ ./greet +---- + +Greet a person. + +[source,console] +---- +$ ./greet Bob +---- + +== Run Dagger Pipeline locally + +[source,console] +---- +$ pushd internal/build && go run . && popd +---- diff --git a/README.md b/README.md deleted file mode 100644 index daaac2e..0000000 --- a/README.md +++ /dev/null @@ -1,40 +0,0 @@ -# Greetings - -## Summary - -Greet is a simple Go CLI application that greets a recipient. -This is a simple project used for the purpose of testing upcoming automation, -such as CI/CD integration and dependency management, which will be used by other projects -hosted in Code Flow. - -## Project's Avatar - -The project's avatar was made by [Smashicons](https://www.flaticon.com/authors/smashicons) from [Flaticon](https://www.flaticon.com). - -## Requirements - -- [Go](https://go.dev/) - -## Build - -``` -go build -o greet . -``` - -## Run - -Greet the world. -``` -./greet -``` - -Greet a person. -``` -./greet Bob -``` - -## Run Dagger Pipeline locally - -``` -pushd internal/build && go run . && popd -```