tauri-apps / tauri-apps/javascriptcore-rs

Document dependencies on README

Open
#66 1 comment 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
100
Forks
19
Avg merge
4h 7m
Merged PRs (30d)
3

Description

Is your feature request related to a problem? Please describe.
It would be helpful if the README.md indicated which system dependencies are needed.

e.g. for openSUSE I needed https://repology.org/project/webkit2gtk3-soup2/versions , which is a bit of an odd name. For GUIX it looks like https://repology.org/project/webkitgtk-with-libsoup2/versions is the one. And Redhat & Debian are obviously hiding this under some other package name, which shouldnt be too hard to find.

Describe the solution you'd like
A list of dependencies, with repology links for each if they are spread across multiple names in the repology database, like this one is.

Ideally a bug or PR is raised in repology or elsewhere to have these odd names merged into a single entry.

Describe alternatives you've considered
Another way to assist the user would be to provide these package names in the build error, where it could be customised to the platform/distro being used, but IMO README is probably suffice for now, and is a good step towards any more informative build error message.

Would you assign yourself to implement this feature?

  • Yes
  • No

Additional context

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review README.md and identify the system dependencies needed to build or use the project, starting with the WebKitGTK dependency mentioned in the issue. Check the relevant Repology links and add a concise dependency list with platform or distribution-specific package names where they differ; done means the README makes these requirements clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.