Adjust README for Flutter Android SDK setup

Open Beginner friendly
#175 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
android, flutter
Domain
documentation, mobile-dev

Research direction

Open README.md and find the pidcat setup instructions that add Android SDK platform-tools and tools to PATH. Compare those instructions with the documented ANDROID_SDK_ROOT shell configuration for Flutter and update the guidance so the unnecessary step is accounted for; done means the README accurately covers this setup.

Written by the indexing model from the issue text.

Description

The README.md suggests the following to be added to the shell config to enable pidcat:

export PATH=$PATH:<path to Android SDK>/platform-tools
export PATH=$PATH:<path to Android SDK>/tools

This step is unnecessary for machines that have the ANDROID_SDK_ROOT environment variable set up in the shell config for Flutter developers. We can modify the documentation to account for this since Android Studio also supports Flutter development.

Dominant language
Python
Stars
5k
Forks
517
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 JakeWharton/pidcat

All issues in JakeWharton/pidcat

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.