aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md101
1 files changed, 48 insertions, 53 deletions
diff --git a/README.md b/README.md
index 0088e93..8b41f39 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
2Bindle Binaries Tools 2Bindle Binaries Tools
3===================== 3=====================
4 4
5 Bindle Binaries Tools is a collection of scripts, autoconf macros, automake 5Bindle Binaries Tools is a collection of scripts, autoconf macros, automake
6 includes, utilities, and library functions which aid in the development of 6includes, utilities, and library functions which aid in the development of
7 software projects. 7software projects.
8 8
9 9
10Contents 10Contents
@@ -22,83 +22,78 @@ Contents
22Disclaimer 22Disclaimer
23========== 23==========
24 24
25 This software is provided by the copyright holders and contributors "as 25This software is provided by the copyright holders and contributors "as
26 is" and any express or implied warranties, including, but not limited to, 26is" and any express or implied warranties, including, but not limited to,
27 the implied warranties of merchantability and fitness for a particular 27the implied warranties of merchantability and fitness for a particular
28 purpose are disclaimed. In no event shall Bindle Binaries be liable for 28purpose are disclaimed. In no event shall Bindle Binaries be liable for
29 any direct, indirect, incidental, special, exemplary, or consequential 29any direct, indirect, incidental, special, exemplary, or consequential
30 damages (including, but not limited to, procurement of substitute goods or 30damages (including, but not limited to, procurement of substitute goods or
31 services; loss of use, data, or profits; or business interruption) however 31services; loss of use, data, or profits; or business interruption) however
32 caused and on any theory of liability, whether in contract, strict 32caused and on any theory of liability, whether in contract, strict
33 liability, or tort (including negligence or otherwise) arising in any way 33liability, or tort (including negligence or otherwise) arising in any way
34 out of the use of this software, even if advised of the possibility of 34out of the use of this software, even if advised of the possibility of
35 such damage. 35such damage.
36 36
37 37
38Software Requirements 38Software Requirements
39===================== 39=====================
40 40
41 GNU GCC 4.2.1 41 * GNU GCC 4.2.1
42 GNU Libtool 2.4 42 * GNU Libtool 2.4
43 GNU Autoconf 2.65 43 * GNU Autoconf 2.65
44 GNU Automake 1.11.1 44 * GNU Automake 1.11.1
45 Git 1.7.2.3 45 * Git 1.7.2.3
46 Bash Shell 46 * Bash Shell
47
48
49 47
50 48
51Source Code 49Source Code
52=========== 50===========
53 51
54 The source code for this project is maintained using git 52The source code for this project is maintained using [git](http://git-scm.com).
55 (http://git-scm.com). The following contains information to checkout the 53The following contains information to checkout the source code from the git
56 source code from the git repository. 54repository.
57 55
58 Browse Source: 56 Browse Source:
59 https://github.com/bindle/bindletools 57 * [https://github.com/bindle/bindletools](https://github.com/bindle/bindletools)
60 http://scm.bindlebinaries.com/scm/com.bindlebinaries/bindletools.git
61 58
62 Git URLs: 59Git URLs:
63 git://github.com/bindle/bindletools.git 60 * [https://github.com/bindle/bindletools.git](https://github.com/bindle/bindletools.git)
64 git://git.scm.bindlebinaries.com/pub/scm/com.bindlebinaries/bindletools.git 61 * [git@github.com:bindle/bindletools.git](git@github.com:bindle/bindletools.git)
65 http://http.scm.bindlebinaries.com/pub/scm/com.bindlebinaries/bindletools.git
66 ssh://ssh.scm.bindlebinaries.com/pub/scm/com.bindlebinaries/bindletools.git
67 62
68 Downloading Source: 63Downloading Source:
69 64
70 $ git clone git://github.com/bindle/bindletools.git 65 $ git clone git://github.com/bindle/bindletools.git
71 66
72 Preparing Source: 67Preparing Source:
73 68
74 $ cd bindletools 69 $ cd bindletools
75 $ ./autogen.sh 70 $ ./autogen.sh
76 71
77 Git Branches: 72Git Branches:
78 master - Current release of packages. 73 * master - Current release of packages.
79 next - changes staged for next release 74 * next - changes staged for next release
80 pu - proposed updates for next release 75 * pu - proposed updates for next release
81 xx/yy+ - branch for testing new changes before merging to 'pu' branch 76 * xx/yy+ - branch for testing new changes before merging to 'pu' branch
82 77
83 78
84Package Maintence Notes 79Package Maintence Notes
85======================= 80=======================
86 81
87 This is a collection of notes for developers to use when maintaining this 82This is a collection of notes for developers to use when maintaining this
88 package. 83package.
89 84
90 New Release Checklist: 85New Release Checklist:
91 86
92 - Switch to 'master' branch in Git repository. 87 - Switch to 'master' branch in Git repository.
93 - Update version in configure.ac. 88 - Update version in configure.ac.
94 - Update date and version in ChangeLog. 89 - Update date and version in ChangeLog.
95 - Commit configure.ac and ChangeLog changes to repository. 90 - Commit configure.ac and ChangeLog changes to repository.
96 - Create tag in git repository: 91 - Create tag in git repository:
97 $ git tag -s v${MAJOR}.${MINOR} 92 $ git tag -s v${MAJOR}.${MINOR}
98 - Push repository to publishing server: 93 - Push repository to publishing server:
99 $ git push --tags origin master:master next:next pu:pu 94 $ git push --tags origin master:master next:next pu:pu
100 95
101 Creating Source Distribution Archives: 96Creating Source Distribution Archives:
102 97
103 $ ./configure 98 $ ./configure
104 $ make update 99 $ make update