Skip to content

Improve documentation: rewrite top-level README and add/update subdirectory READMEs#61

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1770850206-improve-documentation
Open

Improve documentation: rewrite top-level README and add/update subdirectory READMEs#61
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1770850206-improve-documentation

Conversation

@devin-ai-integration
Copy link
Copy Markdown

Summary

Documentation-only PR that overhauls the repo's README coverage:

  • Top-level README.md: Rewritten with a project intro, a full index table (every example directory, main files, one-line description, prerequisites), general compile instructions (cobc -x), multi-file and special build notes, and a section on interactive/screen-mode examples.
  • 8 new subdirectory READMEs added for: comp_test, display_test, display_timing, is_numeric, merge_sort, numval_test, read_command_args, report_writer.
  • 10 existing subdirectory READMEs updated with consistent "How to Compile" / "How to Run" / "Prerequisites" sections: accept, json_generate, mouse, redifines, screen_size, search, sub_program, trim, unstring, xml_generate.
  • sql/README.md was reviewed but left unchanged since it already had thorough build instructions.

No .cbl files or program logic were modified.

Review & Testing Checklist for Human

  • Verify expected output snippets match actual program behavior — outputs in new READMEs (e.g., 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.
  • Check display_test/README.md color description — the README says "cyan foreground on a cyan background" for color codes background-color 03 / foreground-color 06. Verify these ncurses color mappings are accurate (color 06 may actually be yellow, not cyan).
  • Review the index table prerequisites column — confirm the categorization of which examples are interactive vs non-interactive, and which require special libraries, matches your expectations.
  • Trailing whitespace on README.md L75 — there are trailing spaces on the License line in the top-level README (details. ); minor but visible in raw markdown.

Notes

  • The 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.
  • Link to Devin run
  • Requested by: @rdf004

…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>
@devin-ai-integration
Copy link
Copy Markdown
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants