From a2076094aab85c29178278bbd0f27125d9b705fd Mon Sep 17 00:00:00 2001 From: Shulhan Date: Sun, 14 May 2023 19:03:39 +0700 Subject: all: convert README from Asciidoc to Markdown I use two remote repositories: GitHub and SourceHut. GitHub support rendering README using asciidoc while SourceHut not. This cause the repository that use README.adoc rendered as text in SourceHut which make the repository page less readable. Also, the pkg.go.dev now render README but only support Markdown. Since we cannot control the SourceHut and go.dev, the only option is to support converting Markdown in ciigo so I can write README using Markdown and the rest of documentation using Asciidoc. --- README.adoc | 1 - README.md | 172 +++++++++++++++++++++++++------------------------- _www/doc/README.adoc | 1 - _www/doc/README.md | 1 + internal/memfs_www.go | 10 +-- 5 files changed, 93 insertions(+), 92 deletions(-) delete mode 120000 README.adoc delete mode 120000 _www/doc/README.adoc create mode 120000 _www/doc/README.md diff --git a/README.adoc b/README.adoc deleted file mode 120000 index 100b938..0000000 --- a/README.adoc +++ /dev/null @@ -1 +0,0 @@ -README \ No newline at end of file diff --git a/README.md b/README.md index f1b0ed1..3e65242 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,16 @@ -// SPDX-FileCopyrightText: 2019 M. Shulhan -// SPDX-License-Identifier: GPL-3.0-or-later -= awwan -Shulhan -:toc: -:sectanchors: -:sectlinks: -:url-godoc: https://pkg.go.dev/git.sr.ht/~shulhan/awwan +# awwan -image:https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square[GoDoc, link={url-godoc}] +[GoDoc](https://pkg.go.dev/git.sr.ht/~shulhan/awwan) -== NAME +## NAME awwan - Configuration management software, infrastructure as file and directory layout. -== SYNOPSIS +## SYNOPSIS ----- +``` awwan command = "help" / "local" / "play" / "serve" / "version" @@ -57,16 +50,16 @@ line-range = start [ "-" [end] ] *("," line-range) end = 1*DIGITS The end of line number. Its value either empty, equal, or greater than start. ----- +``` -== DESCRIPTION +## DESCRIPTION `awwan` is command-line interface to execute multiple lines of command in the local or remote server using shell or SSH. -== BACKGROUND +## BACKGROUND Do you have a collection of shell scripts to manage one more similar server? Do you ever want to execute only part of your script? @@ -76,7 +69,7 @@ your own server, while you need is a handful of shell script? If yes, awwan is the right tools for you. -== THE COMMAND +## THE COMMAND The awwan tool have three commands: local, play, or serve. @@ -88,7 +81,9 @@ base directory. The "local" and "play" command has the same arguments, -