tofuutils / tofuutils/tenv

Linux manual installation guide is largely incomplete

Open
#263 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue hacktoberfest help wanted
Dominant language
Go
Stars
1.4k
Forks
79
Avg merge
11h 39m
Merged PRs (30d)
2

Description

Describe the bug
Manual installation guide is largely incomplete.

Expected details (example)
If you can escalate to root privileges (with su or sudo or even logging in as root), you can make a system-wide installation of the tenvtool.
Untar the package directly to /usr/bin or any other directory whose name is listed in the $PATH directory. As an option, you can untar it into any other directory (e.g. /usr/local/tenv) and then add it to the system-wide $PATH or even create symlinks from that directory to one already listed in $PATH.
If you cannot escalate to root privileges, you need to untar the package into a directory inde your own $HOME (e.g. ~/bin), add that directory to your local $PATH (e.g. by using your .profile or .login file).

Any subsequent call to tenv will refer to the calling user $HOME directory, thus installing, running and listing whatever binaries are present in the local directory (~/.tenv by default).

Additional context
Clear documentation is key to success IMHO.

Contributor guide

Open the contributing guide

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

Locate the Linux manual installation guide in the repository and compare it with the requested root and non-root installation details in the issue. Update the guide to cover extraction paths, PATH configuration, and the default user-home directory; done means both installation scenarios are explained clearly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.