diff options
| author | David M. Syzdek <david.syzdek@acsalaska.com> | 2020-02-03 15:25:21 -0900 |
|---|---|---|
| committer | David M. Syzdek <david.syzdek@acsalaska.com> | 2020-02-03 15:25:21 -0900 |
| commit | 5f066384dab35a6b972d28e11d7e572f05fdc2ae (patch) | |
| tree | 90168fd4dab09336a3ef680d9e00ca13d757a66e | |
| parent | 45826549c26621056df4edec1d26fccc4dd55c40 (diff) | |
| download | akcom-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.md | 52 |
1 files changed, 51 insertions, 1 deletions
| @@ -46,6 +46,16 @@ Overview | |||
| 46 | This package contains a simple UDP echo server and UDP echo client. | 46 | This package contains a simple UDP echo server and UDP echo client. |
| 47 | 47 | ||
| 48 | 48 | ||
| 49 | Software 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 | |||
| 49 | Source Code | 59 | Source 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 | ||
| 69 | Compiling Source: | 79 | Preparing Source: |
| 80 | |||
| 81 | |||
| 82 | Compiling Source using basic method: | ||
| 70 | 83 | ||
| 84 | $ cd src && make && make install | ||
| 85 | |||
| 86 | Compiling 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 | ||
| 73 | For more information on building and installing using configure, please | 94 | For 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 | |||
| 105 | Package Maintence Notes | ||
| 106 | ======================= | ||
| 107 | |||
| 108 | This is a collection of notes for developers to use when maintaining this | ||
| 109 | package. | ||
| 110 | |||
| 111 | New 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 | |||
| 125 | Creating Source Distribution Archives: | ||
| 126 | |||
| 127 | $ ./configure | ||
| 128 | $ make update | ||
| 129 | $ make distcheck | ||
| 130 | $ make dist-bzip2 | ||
| 131 | $ make dist-xz | ||
| 132 | |||
