make explicit the Java dependency in the README

Open
#674 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
java, python
Domain
cli, documentation

Research direction

README is the named file; start by reviewing its installation and requirements sections. Document that a Java runtime is required, then verify the wording matches the package installation experience. The request to fail before generating files is a separate behavior change and would need investigation beyond the README.

Written by the indexing model from the issue text.

Description

IS: adapt doc

I think it would make sense to specify in the README that this package requires a Java runtime to be present. I only learned this after installing the package.

As an aside, if Java is not installed then the package will generate a few files anyway before failing. It would be nice if transcrypt error-ed out before generating any files.

Dominant language
Python
Stars
2.9k
Forks
218
No merged PRs in 30d

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.

More from TranscryptOrg/Transcrypt

All issues in TranscryptOrg/Transcrypt

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.