diff --git a/docs/index.md b/docs/index.md deleted file mode 120000 index 1073ed5..0000000 --- a/docs/index.md +++ /dev/null @@ -1 +0,0 @@ -libdevuansdk.7.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..a6bbe80 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,29 @@ +index +===== + +`libdevuansdk` is a shell script library intended to unify the use and creation +of various functions spread throughout devuan's various sdks. + +devuan's sdks are designed to be used interactively from a terminal, as +well as from shell scripts. libdevuansdk uses the functionality of the +[zuper](https://github.com/dyne/zuper) zsh library, but it does not include +it. you are required to include it in your sdk. however, `libdevuansdk` +requires the following packages to be installed: + +``` +zsh debootstrap sudo kpartx cgpt xz-utils +``` + +## notes + +to support the development, you are welcome to open issues on problems and +bugs you encounter. open merge requests of patches or simply get involved +in other tasks evident on + +## toc + +* [workflow](workflow.7.html) +* [libdevuansdk configuration](configuration.7.html) +* [libdevuansdk helper functions](helper_functions.7.html) +* [creating wrappers around libdevuansdk](creating_wrappers.7.html) + diff --git a/docs/libdevuansdk.7.md b/docs/libdevuansdk.7.md deleted file mode 100644 index a6bbe80..0000000 --- a/docs/libdevuansdk.7.md +++ /dev/null @@ -1,29 +0,0 @@ -index -===== - -`libdevuansdk` is a shell script library intended to unify the use and creation -of various functions spread throughout devuan's various sdks. - -devuan's sdks are designed to be used interactively from a terminal, as -well as from shell scripts. libdevuansdk uses the functionality of the -[zuper](https://github.com/dyne/zuper) zsh library, but it does not include -it. you are required to include it in your sdk. however, `libdevuansdk` -requires the following packages to be installed: - -``` -zsh debootstrap sudo kpartx cgpt xz-utils -``` - -## notes - -to support the development, you are welcome to open issues on problems and -bugs you encounter. open merge requests of patches or simply get involved -in other tasks evident on - -## toc - -* [workflow](workflow.7.html) -* [libdevuansdk configuration](configuration.7.html) -* [libdevuansdk helper functions](helper_functions.7.html) -* [creating wrappers around libdevuansdk](creating_wrappers.7.html) - diff --git a/docs/libdevuansdk.7.md b/docs/libdevuansdk.7.md new file mode 120000 index 0000000..dd0ea36 --- /dev/null +++ b/docs/libdevuansdk.7.md @@ -0,0 +1 @@ +index.md \ No newline at end of file