aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorDavid M. Syzdek <syzdek@bindlebinaries.com>2017-11-04 13:13:13 -0800
committerDavid M. Syzdek <syzdek@bindlebinaries.com>2017-11-04 13:13:13 -0800
commit7d890bf8c9a00ad44f93df42581774f547706a11 (patch)
treed1ec81add18fc42aa01f1c30b7992263340f8195
parent4a9ad512908564e51734d33f5c4ceb43c997492f (diff)
downloadcorset-next.tar.gz
corset-next.tar.bz2
corset-next.tar.xz
corset-next.zip
Adding my boilerplate READMEHEADnextmaster
-rw-r--r--README.md89
1 files changed, 89 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..150dc42
--- /dev/null
+++ b/README.md
@@ -0,0 +1,89 @@
1
2Corset Firewall
3===============
4
5 Corset Firewall is an open source BRAS like orchestrator for Linux
6 Netfilter.
7
8
9Disclaimer
10==========
11
12 This software is provided by the copyright holders and contributors "as
13 is" and any express or implied warranties, including, but not limited to,
14 the implied warranties of merchantability and fitness for a particular
15 purpose are disclaimed. In no event shall David M. Syzdek be liable for
16 any direct, indirect, incidental, special, exemplary, or consequential
17 damages (including, but not limited to, procurement of substitute goods or
18 services; loss of use, data, or profits; or business interruption) however
19 caused and on any theory of liability, whether in contract, strict
20 liability, or tort (including negligence or otherwise) arising in any way
21 out of the use of this software, even if advised of the possibility of
22 such damage.
23
24
25Maintainers
26===========
27
28 David M. Syzdek
29 david@syzdek.net
30
31
32Source Code
33===========
34
35 The source code for this project is maintained using git
36 (http://git-scm.com). The following contains information to checkout the
37 source code from the git repository.
38
39 Browse Source:
40
41 https://github.com/syzdek/corset
42
43 Git URLs:
44
45 git://github.com/syzdek/corset.git
46 https://github.com/syzdek/corset.git
47 git@github.com:syzdek/corset.git
48
49 Downloading Source:
50
51 $ git clone git://github.com/syzdek/corset.git
52
53 Preparing Source:
54
55 $ cd securecoreutils
56 $ ./autogen.sh
57
58 Git Branches:
59
60 master - Current release of packages.
61 next - changes staged for next release
62 pu - proposed updates for next release
63 xx/yy+ - branch for testing new changes before merging to 'pu' branch
64
65
66Package Maintence Notes
67=======================
68
69 This is a collection of notes for developers to use when maintaining this
70 package.
71
72 New Release Checklist:
73
74 - Switch to 'master' branch in Git repository.
75 - Update version in configure.ac.
76 - Update date and version in ChangeLog.
77 - Commit configure.ac and ChangeLog changes to repository.
78 - Create tag in git repository:
79 $ git tag -s v${MAJOR}.${MINOR}
80 - Push repository to publishing server:
81 $ git push --tags origin master:master next:next pu:pu
82
83 Creating Source Distribution Archives:
84
85 $ ./configure
86 $ make update
87 $ make distcheck
88 $ make dist-bzip2
89