Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
paulrouget authored Jan 20, 2024
1 parent 922f226 commit 3554590
Showing 1 changed file with 8 additions and 32 deletions.
40 changes: 8 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
⚠️ This is a developer dedicated place. If you are a user and need help with Video DownloadHelper and/or its companion app:

- you can find [all relevant links here](https://github.com/aclap-dev/video-downloadhelper).
- if you have an issue with the CoApp not being registered, [read this](https://github.com/aclap-dev/video-downloadhelper/wiki/CoApp-not-recognized).
- [all the documentation is here](https://github.com/aclap-dev/video-downloadhelper/wiki).
- you can [ask questions here](https://github.com/aclap-dev/video-downloadhelper/discussions).


# DownloadHelper CoApp

*DownloadHelper CoApp* is a multi-platform (Windows, Mac, Linux) application
Expand All @@ -16,38 +24,6 @@ and is not intended to be used directly from the command line.
Installer executables for the various platforms are available
from the [releases page](https://github.com/aclap-dev/vdhcoapp/releases).

# Installation

**Windows**: download the `.exe` file, double click on it, and follow the instructions.

**Mac**: download the `.pkg` file, double click on it, and follow the instructions.

**Linux debian-based**: download the `.deb` file and install it: `sudo dpkg -i <deb file>`.

**Linux other**: download the `.tar.bz2` file, unpack and move to a desired location, and run `./vdhcoapp install`.

At this point, the app should be recognised within your browser.

You can check in the Video DownloadHelper add-on settings:

![settings](./assets/instruction1.png "Settings")
![app check](./assets/instruction2.png "App check")

# Alternative installation methods

**Mac DMG**: download the `.dmg` file, open it and move the app to **Application** folder.
Launch the app once to register its manifest within the different browsers (it will show
a notification then close). Re-run the app if you ever move the application to a new location.

**Linux tar.bz2**: download the `.tar.bz2` file, extract it where ever you want to
install the app, then run `<install location>/vdhcoapp install` to register the
manifest within the different browsers. Re-run the install command if you ever move
the application to a new location.

# Troubleshooting

See our troubleshooting section [here](doc/Troubleshooting.md).

# Note about the registration process

After the app is installed, the coapp installs a json file into browser-specific directories,
Expand Down

0 comments on commit 3554590

Please sign in to comment.