From 7d890bf8c9a00ad44f93df42581774f547706a11 Mon Sep 17 00:00:00 2001 From: "David M. Syzdek" Date: Sat, 4 Nov 2017 13:13:13 -0800 Subject: Adding my boilerplate README --- README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..150dc42 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ + +Corset Firewall +=============== + + Corset Firewall is an open source BRAS like orchestrator for Linux + Netfilter. + + +Disclaimer +========== + + This software is provided by the copyright holders and contributors "as + is" and any express or implied warranties, including, but not limited to, + the implied warranties of merchantability and fitness for a particular + purpose are disclaimed. In no event shall David M. Syzdek be liable for + any direct, indirect, incidental, special, exemplary, or consequential + damages (including, but not limited to, procurement of substitute goods or + services; loss of use, data, or profits; or business interruption) however + caused and on any theory of liability, whether in contract, strict + liability, or tort (including negligence or otherwise) arising in any way + out of the use of this software, even if advised of the possibility of + such damage. + + +Maintainers +=========== + + David M. Syzdek + david@syzdek.net + + +Source Code +=========== + + The source code for this project is maintained using git + (http://git-scm.com). The following contains information to checkout the + source code from the git repository. + + Browse Source: + + https://github.com/syzdek/corset + + Git URLs: + + git://github.com/syzdek/corset.git + https://github.com/syzdek/corset.git + git@github.com:syzdek/corset.git + + Downloading Source: + + $ git clone git://github.com/syzdek/corset.git + + Preparing Source: + + $ cd securecoreutils + $ ./autogen.sh + + Git Branches: + + master - Current release of packages. + next - changes staged for next release + pu - proposed updates for next release + xx/yy+ - branch for testing new changes before merging to 'pu' branch + + +Package Maintence Notes +======================= + + This is a collection of notes for developers to use when maintaining this + package. + + New Release Checklist: + + - Switch to 'master' branch in Git repository. + - Update version in configure.ac. + - Update date and version in ChangeLog. + - Commit configure.ac and ChangeLog changes to repository. + - Create tag in git repository: + $ git tag -s v${MAJOR}.${MINOR} + - Push repository to publishing server: + $ git push --tags origin master:master next:next pu:pu + + Creating Source Distribution Archives: + + $ ./configure + $ make update + $ make distcheck + $ make dist-bzip2 + -- cgit v1.2.3