wip3

README.md

@@ -10,7 +10,7 @@
 * `wget` (required for some scripts)
 * `git` (required for some scripts)
 
-If some dependecies are missed for some of these scripts it is enougth to run `./install/apt` in most cases, otherwise script will suggest (or even install) them.
+If some dependencies are missed for some of these scripts, it is enough to run `./install/apt` in most cases; otherwise the script will suggest (or even install) them.
 
 ## Usage
 
@@ -27,18 +27,24 @@ cd shell && make
 
 ## How to add my script?
 
-1. Create a new shell script in `./install`, `./upgrade` or `./uninstall` directory.  
-   At the beggining of a file you must write these two lines:
+1. Create a new shell script in `./install` directory.
+   At the beginning of a file you must write these two lines:
    ```shell
    #!/usr/bin/env bash
    ##makedesc: Your description for Makefile
    ```
-2. Make this script executable, e.g.:
+2. Implement `install()`, `upgrade()` and/or `remove()` functions with `set -eo pipefail` and a trailing `case "$1"` block.
+3. Make this script executable, e.g.:
    ```shell
-   sudo chmod a+x ./install/myscript
+   chmod +x ./install/myscript
    ```
-3. Test your script
-4. Run `make self` to generate new `./Makefile`
+4. Test your script standalone:
+   ```shell
+   ./install/myscript install
+   ./install/myscript upgrade
+   ./install/myscript remove
+   ```
+5. Run `make self` to regenerate `./Makefile`
 
 ## How to create a pack?