summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2023-12-17 18:49:29 +0700
committerShulhan <ms@kilabit.info>2023-12-21 14:38:07 +0700
commit7d89f4c684e85911426937f531ec190854321d65 (patch)
treea4dea1cfdde462fdcc08a8907f47dd9cd7d9ab1c
parentc2dc32980d138564bf77d5866f1cd3c086bed100 (diff)
downloadawwan-7d89f4c684e85911426937f531ec190854321d65.tar.xz
_tour: update README for readability
-rw-r--r--_tour/00_README.txt70
1 files changed, 48 insertions, 22 deletions
diff --git a/_tour/00_README.txt b/_tour/00_README.txt
index 316ca97..ff6c63a 100644
--- a/_tour/00_README.txt
+++ b/_tour/00_README.txt
@@ -1,6 +1,6 @@
= Welcome to awwan
-This is an example of awwan workspace.
+This is a tour of awwan.
The awwan workspace is indicated by ".ssh" directory, as you can see in the
list of file in the left.
@@ -31,40 +31,66 @@ Click on the file "output" to see its content or execute the line below
cat {{.ScriptDir}}/output
+Which will output,
-We provides an example files to follow along, that explain each command and
+ 2023/12/17 11:44:55 --> 32: cat /home/awwan/tour/output
+ Hello world
+
+We provides an tutorial files to follow along, that explain each command and
feature in the awwan.
-01_local.aww - Tutorial on "local" command, to execute command in local
-machine using shell.
+01_local.aww
+
+ Tutorial on "local" command, to execute command in local machine using shell.
+
+02_script_variables.aww
+
+ Tutorial on global variables that can be used in script.
+
+03_env.aww
+
+ Tutorial on how to write and use environment file.
+
+04_env-set.aww
+
+ Tutorial on "env-set" command, or how to set value into environment file.
+
+05_env-get.aww
+
+ Tutorial on "env-get" command, or how to get value from environment file.
+
+06_magic_put.aww
+
+ Tutorial on magic line "#put".
+
+07_magic_get.aww
+
+ Tutorial on magic line "#get".
-02_script_variables.aww - Quick tutorial on global variables that can be
-used in script.
+08_encrypt.aww
-03_env.aww - Tutorial on how to write and use environment file.
+ Tutorial on how to encrypt file and use it to copy file.
-04_env-set.aww - Tutorial on "env-set" command, or how to set value into
-environment file.
+09_decrypt.aww
+ Tutorial on how to decrypt file.
-05_env-get.aww - Tutorial on "env-get" command, or how to get value from
-environment file.
+10_encrypted_env.aww
-06_magic_put.aww - Tutorial on magic line "#put".
+ Tutorial on how to use encrypted environment.
-07_magic_get.aww - Tutorial on magic line "#get".
+11_encrypted_put.aww
-08_encrypt.aww - Tutorial on how to encrypt file and use it to copy file.
+ Tutorial on how to use magic line "#put" with encrypted environment or
+ encrypted file.
-09_decrypt.aww - Tutorial on how to decrypt file.
+12_magic_require.aww
-10_encrypted_env.aww - Tutorial on how to use encrypted environment.
+ Tutorial on how to use magic line "#require".
-11_encrypted_put.aww - Tutorial on how to use magic line "#put" with encrypted
-environment or encrypted file.
+remotehost/01_play.aww
-12_magic_require.aww - Tutorial on how to use magic line "#require".
+ Tutorial on how to use "play" command using SSH in the server named "remotehost".
-remotehost/01_play.aww - Tutorial on how to use "play" command using SSH in
-the server named "remotehost".
+remotehost/02_magic_local.aww
-remotehost/02_magic_local.aww - Tutorial on magic line "#local".
+ Tutorial on magic line "#local".