Skip to content

Commit

Permalink
Merge pull request #14 from cjmayo/archive
Browse files Browse the repository at this point in the history
Don't need git to install from GitHub
  • Loading branch information
cjmayo authored May 1, 2023
2 parents 015df31 + 62f9e3e commit e441ef1
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
7 changes: 2 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,15 @@ jobs:
- name: Install Python dependencies
run: |
python -m pip install -U pip
python -m pip install -U hatchling hatch-vcs markdown2 tox coveralls
python -m pip install -U hatchling hatch-vcs markdown2 tox
- name: Run tests
run: |
python -m hatchling build --hooks-only
xvfb-run --auto-servernum python -m tox -e py
- name: Report to coveralls
run: coveralls
env:
COVERALLS_SERVICE_NAME: github
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
uses: coverallsapp/github-action@f350da2c033043742f89e8c0b7b5145a1616da6d

lint:
name: ${{ matrix.toxenv }}
Expand Down
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,37 @@ Python 3.9 or later is needed. Using pip to install LinkChecker-GUI:

`pip3 install linkchecker-gui`

You may wish to first install the dependencies from you distribution e.g.:

`apt install linkchecker python3-pyqt6.qsci python3-pyqt6.qthelp`

The version in the pip repository may be old, to install the latest code first
install qhelpgenerator e.g.

`apt install qt6-documentation-tools`

Then:

`pip3 install git+https://github.com/linkchecker/linkchecker-gui.git`
`pip3 install https://github.com/linkchecker/linkchecker-gui/archive/master.tar.gz`

## Usage

`linkchecker-gui`

A freedesktop.org desktop entry is installed for compatible environments.

On Debian/Ubuntu if LinkChecker-GUI fails to start with an error:

qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found.

this can be resolved by installing libxcb-cursor0:

`apt install libxcb-cursor0`

Recursion depth and verbose output (whether every URL checked is shown or just those with errors)
are configured in Edit/Options. These settings are specific to LinkChecker-GUI and independent
of LinkChecker. More advanced settings are shared with the default LinkChecker linkcheckerrc.

## Development

Development is managed on [GitHub](https://github.com/linkchecker/linkchecker-gui).

0 comments on commit e441ef1

Please sign in to comment.