mirror of
https://github.com/pdf2htmlEX/pdf2htmlEX.git
synced 2024-12-22 13:00:08 +00:00
corrected documentation
This commit is contained in:
parent
87bc1ba525
commit
d5fd346ba0
@ -29,7 +29,7 @@ to use these scripts to build `pdf2htmlEX`.
|
|||||||
|
|
||||||
## TL;DR ...
|
## TL;DR ...
|
||||||
|
|
||||||
### Downloading precompiled versions {#Downloads}
|
### Downloading precompiled versions
|
||||||
|
|
||||||
For most users, you probably really want to simply download one of the
|
For most users, you probably really want to simply download one of the
|
||||||
[precompiled versions of
|
[precompiled versions of
|
||||||
@ -89,9 +89,9 @@ Unfortunately, the installed versions of both Poppler and FontForge in
|
|||||||
most Linux distributions, lag the official releases of both of these
|
most Linux distributions, lag the official releases of both of these
|
||||||
projects. Even worse few distributions install the same versions.
|
projects. Even worse few distributions install the same versions.
|
||||||
|
|
||||||
This means that it is nearly impossible for the `pdf2htmlEX` 'predict'
|
This means that it is nearly impossible for the `pdf2htmlEX` code to
|
||||||
which version of Poppler or FontForge will be installed on a given user's
|
'predict' which version of Poppler or FontForge will be installed on a
|
||||||
machine.
|
given user's machine.
|
||||||
|
|
||||||
## Our solution
|
## Our solution
|
||||||
|
|
||||||
@ -162,8 +162,7 @@ Typically, most users, will run one of the following "top-level" scripts:
|
|||||||
|
|
||||||
Following successful `buildInstallLocally`, `createImages` and
|
Following successful `buildInstallLocally`, `createImages` and
|
||||||
`runTests`, this will automate the upload of the various artefacts to
|
`runTests`, this will automate the upload of the various artefacts to
|
||||||
the `pdf2htmlEX` releases page, LaunchPad ppa and docker hub
|
the `pdf2htmlEX` releases page, and docker hub repository.
|
||||||
repository.
|
|
||||||
|
|
||||||
**Note** that this step requires the user to enter passwords for each
|
**Note** that this step requires the user to enter passwords for each
|
||||||
of the respective services. *Most* users will not need (or be able) to
|
of the respective services. *Most* users will not need (or be able) to
|
||||||
@ -241,11 +240,6 @@ Typically, most users, will run one of the following "top-level" scripts:
|
|||||||
`pdf2htmlEX/pdf2htmlEX/test` directory. See the
|
`pdf2htmlEX/pdf2htmlEX/test` directory. See the
|
||||||
`pdf2htmlEX/pdf2htmlEx/test` directory's Readme file for details.
|
`pdf2htmlEX/pdf2htmlEx/test` directory's Readme file for details.
|
||||||
|
|
||||||
- **`uploadDebianArchive`**: Upload the `pdf2htmlEX` Debian archive to
|
|
||||||
both the GitHub releases page, as well as the LaunchPad ppa.
|
|
||||||
|
|
||||||
This script has not yet been implemented.
|
|
||||||
|
|
||||||
- **`uploadDockerImage`**: Upload the `pdf2htmlEX` Docker image to
|
- **`uploadDockerImage`**: Upload the `pdf2htmlEX` Docker image to
|
||||||
Docker hub repository associated to the docker hub users specified in
|
Docker hub repository associated to the docker hub users specified in
|
||||||
the `DOCKER_USERNAME` environement variable.
|
the `DOCKER_USERNAME` environement variable.
|
||||||
|
@ -12,7 +12,7 @@ echo ""
|
|||||||
|
|
||||||
set -ev
|
set -ev
|
||||||
|
|
||||||
export DPKG_NAME="pdf2htmlEX-$PDF2HTMLEX_BRANCH-$BUILD_TIME-$MACHINE_ARCH-$BUILD_DIST.deb"
|
export DPKG_NAME="pdf2htmlEX-$PDF2HTMLEX_BRANCH-$BUILD_TIME-$BUILD_DIST-$MACHINE_ARCH.deb"
|
||||||
|
|
||||||
echo "export DPKG_NAME=\"$DPKG_NAME\"" >> buildScripts/reSourceVersionEnvs
|
echo "export DPKG_NAME=\"$DPKG_NAME\"" >> buildScripts/reSourceVersionEnvs
|
||||||
|
|
||||||
|
@ -4,20 +4,22 @@ We release three types of binary objects:
|
|||||||
|
|
||||||
1. The file *.AppImage on this release page is an AppImage
|
1. The file *.AppImage on this release page is an AppImage
|
||||||
|
|
||||||
You can download the AppImage, make it executable and
|
You can download the AppImage, make it executable and then 'just run
|
||||||
then 'just run it'.
|
it'.
|
||||||
|
|
||||||
See: https://appimage.org/ for details
|
See: https://appimage.org/ for details
|
||||||
|
|
||||||
2. The file *.deb is a Debian Archive
|
2. The file *.deb is a Debian Archive
|
||||||
|
|
||||||
You can download the Debian Archive and
|
You can download the Debian Archive and install it locally using:
|
||||||
install it locally using:
|
|
||||||
|
|
||||||
sudo apt install <<releativePathToDebFile>>
|
sudo apt install <<releativePathToDebFile>>
|
||||||
|
|
||||||
3. You can alternatively get pdf2htmlEX Docker images
|
While the Debian archive is built on a specific Ubuntu release, it can
|
||||||
from Docker Hub in either of the repositories:
|
usually be used on any more recent Ubuntu releases.
|
||||||
|
|
||||||
|
3. You can alternatively get pdf2htmlEX Docker images from Docker Hub in
|
||||||
|
either of the repositories:
|
||||||
|
|
||||||
pdf2htmlEX/pdf2htmlEX (offical release)
|
pdf2htmlEX/pdf2htmlEX (offical release)
|
||||||
|
|
||||||
@ -25,9 +27,9 @@ We release three types of binary objects:
|
|||||||
|
|
||||||
stephengaito/pdf2htmlEX (development releases)
|
stephengaito/pdf2htmlEX (development releases)
|
||||||
|
|
||||||
We also release a zip archive of the browser test results
|
We also release a zip archive of the browser test results in the
|
||||||
in the *-testResults.zip file.
|
*-testResults.zip file.
|
||||||
|
|
||||||
Finally, the various *.txt *buildInfo.sh files have well known
|
Finally, the various *.txt and *buildInfo.sh files have well known
|
||||||
(unchanging) names which can be used by automatic scripts to identifiy the
|
(unchanging) names which can be used by automatic scripts to identifiy the
|
||||||
current full names of the binary artifacts.
|
current full names of the corresponding binary artifacts.
|
||||||
|
@ -1,36 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
# This bash script automates the tests
|
|
||||||
|
|
||||||
mkdir -p testDir
|
|
||||||
|
|
||||||
cd testDir
|
|
||||||
|
|
||||||
wget https://github.com/stephengaito/pdf2htmlEX/releases/download/continuous/appImageName
|
|
||||||
|
|
||||||
export APPIMAGE_NAME=$(cat appImageName)
|
|
||||||
|
|
||||||
wget https://github.com/stephengaito/pdf2htmlEX/releases/download/continuous/$APPIMAGE_NAME
|
|
||||||
|
|
||||||
chmod a+x $APPIMAGE_NAME
|
|
||||||
|
|
||||||
if ! ./$APPIMAGE_NAME --version ; then
|
|
||||||
echo "COULD NOT run the AppImage"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -x "$(which docker)" ]; then
|
|
||||||
|
|
||||||
wget https://github.com/stephengaito/pdf2htmlEX/releases/download/continuous/dockerImageName
|
|
||||||
|
|
||||||
export DOCKER_IMAGE_NAME=$(cat dockerImageName)
|
|
||||||
|
|
||||||
if ! docker run $DOCKER_IMAGE_NAME --version ; then
|
|
||||||
echo "COULD NOT run the Docker Image"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
fi
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
# This bash script automates the tests
|
|
||||||
|
|
||||||
wget https://github.com/stephengaito/pdf2htmlEX/releases/download/continuous/appImageName
|
|
||||||
|
|
||||||
export APPIMAGE_NAME=$(cat appImageName)
|
|
||||||
|
|
||||||
wget https://github.com/stephengaito/pdf2htmlEX/releases/download/continuous/$APPIMAGE_NAME
|
|
||||||
|
|
||||||
chmod a+x $APPIMAGE_NAME
|
|
||||||
|
|
||||||
if ! ./$APPIMAGE_NAME --version ; then
|
|
||||||
echo "COULD NOT run the AppImage"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -x "$(which docker)" ]; then
|
|
||||||
|
|
||||||
wget https://github.com/stephengaito/pdf2htmlEX/releases/download/continuous/dockerImageName
|
|
||||||
|
|
||||||
export DOCKER_IMAGE_NAME=$(cat dockerImageName)
|
|
||||||
|
|
||||||
if ! docker run $DOCKER_IMAGE_NAME --version ; then
|
|
||||||
echo "COULD NOT run the Docker Image"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
fi
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user