add readme

This commit is contained in:
parazyd 2016-09-29 22:02:25 +02:00
parent 076d7203ff
commit 91b1f24e1c
No known key found for this signature in database
GPG Key ID: F0CB28FCF78637DE
7 changed files with 65 additions and 20 deletions

7
CONTRIBUTORS.md Normal file
View File

@ -0,0 +1,7 @@
Contributors
============
Thank you very much for your great help and ideas!
- Enzo Nicosia <katolaz@freaknet.org>
- Denis Roio <jaromil@dyne.org>

52
README.md Normal file
View File

@ -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 <https://git.devuan.org>
## 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. <parazyd@dyne.org>
- Denis Roio <jaromil@dyne.org>
- Enzo Nicosia <katolaz@freaknet.org>
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 <http://www.gnu.org/licenses/>.

5
config
View File

@ -1,9 +1,6 @@
#!/usr/bin/env zsh
#
# Copyright (c) 2016 Dyne.org Foundation
# libdevuansdk is written and maintained by Ivan J. <parazyd@dyne.org>
# with code contributions from KatolaZ <katolaz@freaknet.org>
# and Jaromil <jaromil@dyne.org>
# libdevuansdk is maintained by Ivan J. <parazyd@dyne.org>
#
# This file is part of libdevuansdk
#

View File

@ -1,9 +1,6 @@
#!/usr/bin/env zsh
#
# Copyright (c) 2016 Dyne.org Foundation
# libdevuansdk is written and maintained by Ivan J. <parazyd@dyne.org>
# with code contributions from KatolaZ <katolaz@freaknet.org>
# and Jaromil <jaromil@dyne.org>
# libdevuansdk maintained by Ivan J. <parazyd@dyne.org>
#
# This file is part of libdevuansdk
#

View File

@ -1,9 +1,6 @@
#!/usr/bin/env zsh
#
# Copyright (c) 2016 Dyne.org Foundation
# libdevuansdk is written and maintained by Ivan J. <parazyd@dyne.org>
# with code contributions from KatolaZ <katolaz@freaknet.org>
# and Jaromil <jaromil@dyne.org>
# libdevuansdk maintained by Ivan J. <parazyd@dyne.org>
#
# 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
}

View File

@ -1,9 +1,6 @@
#!/usr/bin/env zsh
#
# Copyright (c) 2016 Dyne.org Foundation
# libdevuansdk is written and maintained by Ivan J. <parazyd@dyne.org>
# with code contributions from KatolaZ <katolaz@freaknet.org>
# and Jaromil <jaromil@dyne.org>
# libdevuansdk is maintained by Ivan J. <parazyd@dyne.org>
#
# This file is part of libdevuansdk
#

View File

@ -1,9 +1,6 @@
#!/usr/bin/env zsh
#
# Copyright (c) 2016 Dyne.org Foundation
# libdevuansdk is written and maintained by Ivan J. <parazyd@dyne.org>
# with code contributions from KatolaZ <katolaz@freaknet.org>
# and Jaromil <jaromil@dyne.org>
# libdevuansdk is maintained by Ivan J. <parazyd@dyne.org>
#
# This file is part of libdevuansdk
#