From 53c475697da43838a5fafc722f859b4dd8c18436 Mon Sep 17 00:00:00 2001 From: zrep Date: Sat, 6 Apr 2024 09:38:08 +0200 Subject: [PATCH] Updated formatting of the documentation --- Create-Your-Script.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Create-Your-Script.md b/Create-Your-Script.md index 87a5209..5d44b30 100644 --- a/Create-Your-Script.md +++ b/Create-Your-Script.md @@ -1,9 +1,9 @@ # How to create your own script -The scripts used in `zpi` are using the `autoload` function of Zsh. This means that your script have to be in `$fpath` to be found by Zsh. -This is where `zpi` comes in. +The scripts used in **zpi** are using the **autoload** function of Zsh. This means that your script have to be in **$fpath** to be found by Zsh. +This is where **zpi** comes in. -`zpi` is created to handle the installation and management of scripts. +**zpi** is created to handle the installation and management of scripts. ## Create your script @@ -17,10 +17,10 @@ Example: Based on my research, it is possible to have functions within the main function, so it should be possible to create complex and very interesting scripts for the community. -`zpi` depends on one file to display help information to the user. -Using `zpi author/package help` will display the information in the file `USAGE`. +**zpi** depends on one file to display help information to the user. +Using **zpi author/package help** will display the information in the file **USAGE**. -The file `README.md` is used on the web page when people visit your package page. This file is optional, but highly recommended. +The file **README.md** is used on the web page when people visit your package page. This file is optional, but highly recommended. In other words, the file structure you should aim for is: - script_name