Improve documentation: rewrite top-level README and add/update subdirectory READMEs#61
Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
Conversation
…ectory READMEs - Rewrite top-level README with intro, examples index table, compile instructions, and notes about interactive examples - Add README.md for: comp_test, display_test, display_timing, is_numeric, merge_sort, numval_test, read_command_args, report_writer - Add compile/run instructions to existing READMEs: accept, json_generate, mouse, redifines, screen_size, search, sub_program, trim, unstring, xml_generate Co-Authored-By: Roshan Fernando <roshandean4@gmail.com>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only PR that overhauls the repo's README coverage:
cobc -x), multi-file and special build notes, and a section on interactive/screen-mode examples.comp_test,display_test,display_timing,is_numeric,merge_sort,numval_test,read_command_args,report_writer.accept,json_generate,mouse,redifines,screen_size,search,sub_program,trim,unstring,xml_generate.sql/README.mdwas reviewed but left unchanged since it already had thorough build instructions.No
.cblfiles or program logic were modified.Review & Testing Checklist for Human
comp_test,numval_test,is_numeric,merge_sort) were derived from reading source, not from running the programs. Worth spot-checking a few by compiling and running.display_test/README.mdcolor description — the README says "cyan foreground on a cyan background" for color codesbackground-color 03/foreground-color 06. Verify these ncurses color mappings are accurate (color 06 may actually be yellow, not cyan).details.); minor but visible in raw markdown.Notes
redifines/directory name itself is a typo (should be "redefines") — the PR documents it as-is without renaming, which seems intentional for the original repo.