Please, write better docs
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 9.2k
- Forks
- 1.3k
- Avg merge
- 12h 58m
- Merged PRs (30d)
- 56
Description
I'd like to build keybase apk on my laptop (Debian sid), I've installed everything as it was written in readmes, I have SDK tools, android-studio (I've tried "Without Android Studio" way too), but without any luck. I've ran over all types of issues, starting from Could not read script xxxx and ending on Not compatible with your version of node/npm. And now, after about 5 hours I've decided to give up and seek for help.
I'd like to have build docs similar to bitcoin's build-unix.md, where I get list of apt commands to execute, and list of commands to compile wallet, with explanation of what every option does.
As an alternative you could provide an docker image that will build everything, so we can open it and read commands one by one and understand what exactly is needed to do.
(It's also worth mentioning that I have nearly 0 experience with working with GO, and little experience with working with java, but I wanted to read code anyway, and mod that app a bit to fit my needs, because I know JavaScript, and I tough that it will be enough for editing frontend of app...)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository README files and the referenced Bitcoin build-unix.md as examples of the requested build guidance. Document the Debian package commands, Android build commands, and option explanations, or define a Docker-based build path; done means a newcomer can follow the steps to produce the Keybase APK.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android, debian, docker, go, java, javascript, react-native
- Domain
- build-system, documentation, mobile
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100