Skip to content

Commit 7091efe

Browse files
committed
Update changelog and build instructions.
1 parent 4fc5698 commit 7091efe

File tree

2 files changed

+63
-45
lines changed

2 files changed

+63
-45
lines changed

CHANGES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Changes in HTMLDOC
44
v1.9.21 (YYYY-MM-DD)
55
--------------------
66

7-
- Update HTTP/HTTPS connection error reporting to include the reason.
7+
- Updated HTTP/HTTPS connection error reporting to include the reason.
88
- Updated markdown parser.
99
- Fixed a bug in the new PDF link code (Issue #536)
1010
- Fixed a bug in the number-up code (Issue #539)

INSTALL.md

Lines changed: 62 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,56 @@
1-
How to Install HTMLDOC from Source
2-
==================================
1+
Building and Installing HTMLDOC
2+
===============================
3+
4+
This file describes how to compile and install HTMLDOC from source code. For
5+
more information on HTMLDOC see the file called `README.md`.
6+
7+
8+
Before You Begin
9+
----------------
310

411
To compile HTMLDOC you'll need C and C++ compilers (clang and gcc are fine)
512
along with the following libraries:
613

7-
- FLTK 1.1.x or higher for GUI support
8-
- CUPS 2.2 or higher for HTTP/HTTPS support
9-
- libjpeg (7 or higher) or libjpeg-turbo for JPEG support
10-
- libpng 1.6 or higher for PNG support
11-
- zlib 1.1 or higher
14+
- FLTK 1.3.x+ for GUI support
15+
- CUPS 2.2+ for HTTP/HTTPS support
16+
- libjpeg 7+ or libjpeg-turbo for JPEG support
17+
- libpng 1.6+ or higher for PNG support
18+
- zlib 1.1+ or higher
1219

1320

14-
Windows
15-
-------
21+
Getting Prerequisites
22+
---------------------
1623

17-
Visual Studio + Advanced Installer solutions are included in the "vcnet"
18-
directory. The Visual Studio solution uses NuGet packages for all of the
19-
dependent libraries, and the current version of Advanced Installer is required
20-
to build the installer (MSI) target.
24+
CentOS 8/Fedora 23+/RHEL 8:
2125

22-
We highly recommend building and installing the HTMLDOC MSI target, as it takes
23-
care of registering the installation location with Windows. If you want to
24-
install the software by hand, create a directory for the software and copy the
25-
HTMLDOC executable, the "fonts" directory, the "data" directory, and the "doc"
26-
directory to it so that it looks like this:
26+
sudo dnf groupinstall 'Development Tools'
27+
sudo dnf install cups-devel libjpeg-turbo-devel libpng-devel zlib-devel
2728

28-
C:\Install\Dir\
29-
htmldoc.exe
30-
data\
31-
... data files ...
32-
doc\
33-
... doc files ...
34-
fonts\
35-
... fonts files ...
29+
Debian/Raspbian/Ubuntu:
3630

37-
Then create the following registry entries with REGEDIT:
31+
sudo apt-get install build-essential libcups2-dev libjpeg-dev libpng-dev \
32+
zlib1g-dev
3833

39-
HKEY_LOCAL_MACHINE\Software\HTMLDOC\doc = C:\install\dir\doc
40-
HKEY_LOCAL_MACHINE\Software\HTMLDOC\data = C:\install\dir
34+
macOS:
35+
36+
- Install Xcode from the AppStore
37+
- Install brew if necessary from <https://brew.sh>
38+
- Run the following commands to install the required image libraries:
4139

40+
brew install libjpeg
41+
brew install libpng
4242

43-
Linux, macOS, and Other UNIX Platforms
44-
--------------------------------------
43+
Windows:
4544

46-
To compile the software under UNIX you first need to run the "configure" script
47-
in the source directory. Usually this is just:
45+
- Install Visual Studio 2019+
46+
- Install Advanced Installer for making MSI installer files
47+
48+
49+
Building on Linux, macOS, and Other Unix Platforms
50+
--------------------------------------------------
51+
52+
To compile the software you first need to run the "configure" script in the
53+
source directory. Usually this is just:
4854

4955
./configure
5056

@@ -57,19 +63,31 @@ Finally, run "make install" (typically as root) to install the software:
5763
sudo make install
5864

5965

60-
Ubuntu and Debian Notes
61-
-----------------------
66+
Building on Windows
67+
-------------------
6268

63-
You should install the following packages:
64-
65-
sudo apt-get install build-essential autoconf libfltk1.3-dev \
66-
libcups2-dev libjpeg-dev libpng-dev pkg-config zlib1g-dev
69+
Visual Studio + Advanced Installer projects are included in the "vcnet"
70+
directory. The Visual Studio project uses NuGet packages for all of the
71+
dependent libraries, and the current version of Advanced Installer is required
72+
to build the installer (MSI) target.
6773

74+
We highly recommend building and installing the HTMLDOC MSI target, as it takes
75+
care of registering the installation location with Windows. If you want to
76+
install the software by hand, create a directory for the software and copy the
77+
HTMLDOC executable, the "fonts" directory, the "data" directory, and the "doc"
78+
directory to it so that it looks like this:
6879

69-
CentOS, Fedora, and RHEL Notes
70-
------------------------------
80+
C:\Install\Dir\
81+
data\
82+
... data files ...
83+
doc\
84+
... doc files ...
85+
fonts\
86+
... fonts files ...
87+
ghtmldoc.exe
88+
htmldoc.exe
7189

72-
Install the following packages to get full functionality:
90+
Then create the following registry entries with REGEDIT:
7391

74-
sudo dnf install autoconf fltk-devel cups-devel libjpeg-devel \
75-
libpng-devel pkgconfig zlib-devel
92+
HKEY_LOCAL_MACHINE\Software\HTMLDOC\doc = C:\install\dir\doc
93+
HKEY_LOCAL_MACHINE\Software\HTMLDOC\data = C:\install\dir

0 commit comments

Comments
 (0)