diff --git a/README.md b/README.md index 823cabb..74ca3fc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,51 @@ -# dorelease +do-release +========== -bash script to do the packaging for Friendica releases. \ No newline at end of file +This script creates archives for the Friendica core and the addons +from the current state of the repositories. The core archive will +contain the composer dependencies. + +The naming scheme for the archives will be + friendica-full-{$VERSION].tar.gz + friendica-addons-{$VERSION}.tar.gz + +Additionally the SHA256 check sums will be calculated and piped into +a text file. + +Parameters +---------- + + You have to supply the script a "Version Number" that will be used + as hinted above. It can be anything, but you should stick to the + current versioning scheme of Friendica. + +USAGE +----- + + 1. prepare the core directory to reflext the state you want to pack + e.g. the stable release of Friendica + 2. prepare the addons directory + 3. run this script with the version as one and only parameter + +License +------- + +Copyright (C) 2020 Tobias Diekershoff + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.