From 91b1f24e1cfa25ada9fa7a6bb8758a08a4ca2ecd Mon Sep 17 00:00:00 2001 From: parazyd Date: Thu, 29 Sep 2016 22:02:25 +0200 Subject: [PATCH] add readme --- CONTRIBUTORS.md | 7 +++++++ README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++ config | 5 +---- libdevuansdk | 5 +---- zlibs/bootstrap | 6 ++---- zlibs/helpers | 5 +---- zlibs/sysconf | 5 +---- 7 files changed, 65 insertions(+), 20 deletions(-) create mode 100644 CONTRIBUTORS.md create mode 100644 README.md diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..c51ecea --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,7 @@ +Contributors +============ + +Thank you very much for your great help and ideas! + +- Enzo Nicosia +- Denis Roio diff --git a/README.md b/README.md new file mode 100644 index 0000000..97b200a --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +libdevuansdk +============ + +libdevuansdk is a shell script library intended to unify the use and +creation of various functions spread throughout Devuan's various SDKs. + +## Requirements + +Devuan's SDKs are designed to be used interactively from a terminal, as +well as from shell scripts. It requires the following packages to be +installed: + +``` +zsh debootstrap sudo +``` + +## Documentation + +Find documentation inside the `doc` directory of libdevuansdk. + +## 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 + +## Acknowledgments + +Devuan's SDK was originally conceived during a period of residency at the +Schumacher college in Dartington, UK. Greatly inspired by the laborious and +mindful atmosphere of its wonderful premises. + +The Devuan SDk is Copyright (c) 2015-2016 by the Dyne.org Foundation + +Devuan SDK components are designed, written and maintained by: + +- Ivan J. +- Denis Roio +- Enzo Nicosia + +This source code is free software: you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the Free +Software Foundation, either version 3 of the License, or (at your option) +any later version. + +This software is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. + +You should have received a copy of the GNU General Public License along +with this source code. If not, see . diff --git a/config b/config index 8b64c0d..6c87f39 100644 --- a/config +++ b/config @@ -1,9 +1,6 @@ #!/usr/bin/env zsh -# # Copyright (c) 2016 Dyne.org Foundation -# libdevuansdk is written and maintained by Ivan J. -# with code contributions from KatolaZ -# and Jaromil +# libdevuansdk is maintained by Ivan J. # # This file is part of libdevuansdk # diff --git a/libdevuansdk b/libdevuansdk index cb641f3..d7436d0 100644 --- a/libdevuansdk +++ b/libdevuansdk @@ -1,9 +1,6 @@ #!/usr/bin/env zsh -# # Copyright (c) 2016 Dyne.org Foundation -# libdevuansdk is written and maintained by Ivan J. -# with code contributions from KatolaZ -# and Jaromil +# libdevuansdk maintained by Ivan J. # # This file is part of libdevuansdk # diff --git a/zlibs/bootstrap b/zlibs/bootstrap index 81b4e8d..ba290d1 100644 --- a/zlibs/bootstrap +++ b/zlibs/bootstrap @@ -1,9 +1,6 @@ #!/usr/bin/env zsh -# # Copyright (c) 2016 Dyne.org Foundation -# libdevuansdk is written and maintained by Ivan J. -# with code contributions from KatolaZ -# and Jaromil +# libdevuansdk maintained by Ivan J. # # This file is part of libdevuansdk # @@ -94,6 +91,7 @@ rm -f /etc/ssh/*.pub rm -f /root/.bash_history ## our file for which we check the bootstrap is complete echo "1" > .done +rm -f /cleanup EOF } diff --git a/zlibs/helpers b/zlibs/helpers index f57ddb0..6db5373 100644 --- a/zlibs/helpers +++ b/zlibs/helpers @@ -1,9 +1,6 @@ #!/usr/bin/env zsh -# # Copyright (c) 2016 Dyne.org Foundation -# libdevuansdk is written and maintained by Ivan J. -# with code contributions from KatolaZ -# and Jaromil +# libdevuansdk is maintained by Ivan J. # # This file is part of libdevuansdk # diff --git a/zlibs/sysconf b/zlibs/sysconf index ef4881a..6ffcf20 100644 --- a/zlibs/sysconf +++ b/zlibs/sysconf @@ -1,9 +1,6 @@ #!/usr/bin/env zsh -# # Copyright (c) 2016 Dyne.org Foundation -# libdevuansdk is written and maintained by Ivan J. -# with code contributions from KatolaZ -# and Jaromil +# libdevuansdk is maintained by Ivan J. # # This file is part of libdevuansdk #