docs: add md2view documentation to README - #53
Conversation
Added instructions to build `md2view` in the `Install` section, and added a specific `md2view usage` section noting the basic CLI command, its functionality, and keyboard/mouse controls. Co-authored-by: arran4 <[email protected]>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Documentation previewsThe rendered README and example images are available as workflow artifacts.
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to include build and usage instructions for the new md2view GUI Markdown viewer. The reviewer suggested simplifying the example command in the documentation by passing the input file as a positional argument instead of using the -in flag.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Updates the `md2view` usage example to use the simpler positional argument instead of the `-in` flag, resulting in a cleaner CLI command (`./md2view README.md`). Co-authored-by: arran4 <[email protected]>
…view-11106907725313379119 Update documentation images for #53
1 participant
This PR adds missing documentation for the
md2viewGUI tool directly to the repository'sREADME.md. It explains how to build the tool, execute it via the CLI, and interacts with the rendered markdown view via mouse and keyboard commands.PR created automatically by Jules for task 11106907725313379119 started by @arran4