aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorDavid M. Syzdek <david.syzdek@acsalaska.com>2020-02-03 15:25:21 -0900
committerDavid M. Syzdek <david.syzdek@acsalaska.com>2020-02-03 15:25:21 -0900
commit5f066384dab35a6b972d28e11d7e572f05fdc2ae (patch)
tree90168fd4dab09336a3ef680d9e00ca13d757a66e
parent45826549c26621056df4edec1d26fccc4dd55c40 (diff)
downloadakcom-udpecho-5f066384dab35a6b972d28e11d7e572f05fdc2ae.tar.gz
akcom-udpecho-5f066384dab35a6b972d28e11d7e572f05fdc2ae.tar.bz2
akcom-udpecho-5f066384dab35a6b972d28e11d7e572f05fdc2ae.tar.xz
akcom-udpecho-5f066384dab35a6b972d28e11d7e572f05fdc2ae.zip
docs: updating README
-rw-r--r--README.md52
1 files changed, 51 insertions, 1 deletions
diff --git a/README.md b/README.md
index 342e89d..2e58c92 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,16 @@ Overview
46This package contains a simple UDP echo server and UDP echo client. 46This package contains a simple UDP echo server and UDP echo client.
47 47
48 48
49Software Requirements
50=====================
51
52 * GNU GCC 4.2.1
53 * GNU Libtool 2.4
54 * GNU Autoconf 2.65
55 * GNU Automake 1.11.1
56 * Git 1.7.2.3
57
58
49Source Code 59Source Code
50=========== 60===========
51 61
@@ -66,8 +76,19 @@ Downloading Source:
66 76
67 $ git clone https://scm.prv.acsalaska.net/pub/scm/ipeng/akcom-udpecho.git 77 $ git clone https://scm.prv.acsalaska.net/pub/scm/ipeng/akcom-udpecho.git
68 78
69Compiling Source: 79Preparing Source:
80
81
82Compiling Source using basic method:
70 83
84 $ cd src && make && make install
85
86Compiling Source using GNU autotools method:
87
88 $ cd akcom-udpecho
89 $ ./autogen.sh
90 $ cd build
91 $ ./configure
71 $ make && make install 92 $ make && make install
72 93
73For more information on building and installing using configure, please 94For more information on building and installing using configure, please
@@ -80,3 +101,32 @@ Git Branches:
80 * pu - proposed updates for next release 101 * pu - proposed updates for next release
81 * xx/yy+ - branch for testing new changes before merging to 'pu' branch 102 * xx/yy+ - branch for testing new changes before merging to 'pu' branch
82 103
104
105Package Maintence Notes
106=======================
107
108This is a collection of notes for developers to use when maintaining this
109package.
110
111New Release Checklist:
112
113 - Switch to 'master' branch in Git repository.
114 - Update version in configure.ac.
115 - Update date and version in ChangeLog.
116 - Commit configure.ac and ChangeLog changes to repository.
117 - Create tag in git repository:
118
119 $ git tag -s v${MAJOR}.${MINOR}
120
121 - Push repository to publishing server:
122
123 $ git push --tags origin master:master next:next pu:pu
124
125Creating Source Distribution Archives:
126
127 $ ./configure
128 $ make update
129 $ make distcheck
130 $ make dist-bzip2
131 $ make dist-xz
132