Clean agent comments from main readme

[malhotra5]

The OpenHands agent create a README.md file in the root of the project with a bunch of unorganized information across multiple conversations.

We should rework the readme completely

1. write concise steps for installing uv, and running the CLI locally

2. write instructions on building the executable binary, then using the executable to run the CLI

Add a Development.md which can have more verbose instructions on how to make changes to CLI; this should cover

1. installing new poetry dependencies
2. modifying the spec file (to include packages that didn't get included for whatever reason; mention difference between hiddenimports and data)
3. creating a build locally and testing that it works

[malhotra5]

@OpenHands please do this; be very refined, concise, yet helpful and comprehensive

[openhands-ai]

I'm on it! malhotra5 can track my progress at all-hands.dev

🔴 Solvability: HARD

This issue is extremely challenging to resolve due to the complete absence of essential information - there is no title, description, error details, or technical context provided. The vague request lacks the fundamental details needed to understand what problem needs to be solved or what specific action is required.

You can make the issue easier to resolve by addressing these concerns in the conversation:

• Provide a clear, descriptive title that summarizes the specific problem or request
• Include a detailed description explaining what you're trying to accomplish, what's currently happening, and what you expect to happen instead
• Add relevant technical details such as error messages, code snippets, environment information, or reproduction steps to give context for the issue

[openhands-ai]

Final summary

What I changed

• README.md: Rewrote to be concise and action-oriented
  • Added uv install steps
  • Added clear instructions to run the CLI locally
  • Added build-and-use instructions for the standalone executable
• Development.md: Added detailed developer guide
  • How to add dependencies (uv and Poetry)
  • PyInstaller spec guidance, including hiddenimports vs datas
  • Local build and executable testing steps
  • Lint/format commands and credential notes

Verifications since last summary

• Linting: make lint passed all hooks
• Tests: make test passed (11 tests)

Checklist against issue #19

• Concise steps to install uv and run the CLI locally in README.md: Done
• Instructions to build the executable and use it in README.md: Done
• Development.md with:
  • Installing new Poetry/uv dependencies: Done
  • Spec file guidance, including hiddenimports vs data: Done
  • Creating a local build and testing it: Done

Scope and concision

• Only changed documentation (README.md) and added Development.md
• No code changes; no extraneous modifications

Branch and PR

• Branch: openhands/clean-readme-and-add-development-md
• PR: Clean README and add Development.md for build/developer guidance #20
• PR closes Clean agent comments from main readme #19

Next step

• Please review and merge the PR.

_{View full conversation}