doc: rewrite README with asciidoc
Some checks are pending
ci/woodpecker/push/woodpecker Pipeline is pending
Some checks are pending
ci/woodpecker/push/woodpecker Pipeline is pending
This commit is contained in:
parent
f7805184a0
commit
7d7d87b57b
2 changed files with 46 additions and 40 deletions
46
README.asciidoc
Normal file
46
README.asciidoc
Normal file
|
@ -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
|
||||
----
|
40
README.md
40
README.md
|
@ -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
|
||||
```
|
Loading…
Reference in a new issue