11
2- PACKAGING NOTES SCRIPT
2+ # PACKAGING NOTES SCRIPT
33
44We welcome contributions from others helping to package NOTES for
55different BSD/Linux distributions.
66
7- CURRENTLY PLANNED BY AUTHOR
7+
8+ ## CURRENTLY IMPLEMENTED
9+
10+ At of the timestamp of this file we have the following packaging
11+ systems implemented for the NOTES system:
12+
13+ - source tarball for use with 'sudo make install'
14+ - Debian
15+ - Ubuntu based systems should be able to use the Debian .deb package
16+
17+
18+ ## CREATING PACKAGES FROM THE SOURCE TARBALL OR GIT CLONE
19+
20+ Each implemented packaging can be created from the source tarball or a
21+ git clone/download by changing directory to the appropriate
22+ distribution directory and running make. Obviously you should run the
23+ builds on the distribution the makefile is building for (Debian on
24+ Debian etc) unless your distribution includes the appropriate target OS
25+ packaging software.
26+
27+ DEBIAN / UBUNTU
28+
29+ To create a Debian package from the source:
30+
31+ $ cd pkgs/debian
32+ $ make deb
33+
34+ This will create a Debian .deb package and a *.sha256.txt file
35+ for the package. The .deb package and the .sha256.txt files
36+ will be created in the pkgs/debian directory.
37+
38+
39+ ## CURRENTLY PLANNED BY AUTHOR
840
941I will be packaging for the following operating systems, based upon the
1042OS I have easily available to me:
1143
1244- FreeBSD
13- - Debian Linux
14- - source tarball for use with 'make install'
1545
16- OTHER PACKAGING DESIRED
46+
47+ ## OTHER PACKAGING DESIRED
1748
1849We would love to see the scripts packaged for other operating systems
1950including the following:
2051
2152- Arch Linux
2253- Manjaro Linux
23- - Ubuntu
2454- Fedora
2555
2656We will incorporate packaging for any BSD/Linux that contributors would
2757like to commit to building.
2858
29- PACKAGING
59+
60+ ## CONTRIBUTING TO PACKAGING
3061
3162For ease of maintenance, packagers should create a sub directory under
3263[repo]/pkgs named after the distribution (see pkgs/debian, pkgs/freebsd
@@ -42,3 +73,18 @@ to build the package according to the distribution requirements.
4273Please ensure that the package has the appropriate dependencies for end
4374users. See the file DEPENDENCIES for details.
4475
76+
77+ ## CREATING A SOURCE TARBALL FROM THE MAIN SOURCE CODE DIRECTORY
78+
79+ If desired you can make a gzipped tarball of the distribution at the
80+ current HEAD of the repo by performing the following in the top
81+ directory of the source code:
82+
83+ $ make tarball
84+
85+ This will create a gzipped tarball 'unix-notes-(VERSION)-tar.gz' using
86+ the command 'git archive' command and also create a file
87+ 'unix-notes-(VERSION)-sha256.txt' containing the SHA256 fingerprint of
88+ the tarball to help installation security.
89+
90+
0 commit comments