kekePower/zpi
kekePower/zpi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

Updated formatting of the documentation

zrep 2024-04-06 09:38:08 +02:00
parent 289a67644d
commit 53c475697d
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Create-Your-Script.md

@ -1,9 +1,9 @@
# How to create your own script # 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. 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. 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 ## 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. 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. **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`. 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: In other words, the file structure you should aim for is:
- script_name - script_name