Skip to content

docs: update per-program readmes#80

Merged
logic-finder merged 7 commits into
mainfrom
fix-readmes
Jul 24, 2026
Merged

docs: update per-program readmes#80
logic-finder merged 7 commits into
mainfrom
fix-readmes

Conversation

@logic-finder

Copy link
Copy Markdown
Contributor
  • 프로그램별로 가지고 있는 기존 readme 파일들 수정
  • nsy2 readme 없길래 추가

closes #67.

@logic-finder
logic-finder requested a review from lshqqytiger June 12, 2026 15:37
@logic-finder logic-finder self-assigned this Jun 12, 2026
@logic-finder logic-finder added the documentation Improvements or additions to documentation label Jun 12, 2026
@logic-finder
logic-finder marked this pull request as draft June 13, 2026 10:19
@logic-finder
logic-finder marked this pull request as ready for review July 23, 2026 07:08
@lshqqytiger
lshqqytiger requested a review from Copilot July 23, 2026 07:14

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates per-program documentation to better reflect how each utility is built and invoked, including adding missing documentation for nsy2 and addressing Issue #67’s note about hd usage.

Changes:

  • Standardized several programs’ Usage sections (notably updating hd to show stdin redirection instead of a positional argument).
  • Updated some build instructions (e.g., switching from direct compiler invocation to make where a Makefile exists).
  • Added a new nsy2/README.md.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
yandere/README.md Updates usage/build snippets for yandere documentation.
nsy2/README.md Adds new README for nsy2 with usage and build instructions.
nsy/README.md Adjusts usage snippet formatting/content.
hhss/README.md Adjusts usage snippet formatting/content.
hd/README.md Updates usage to reflect stdin-based behavior (Issue #67).
btn/README.md Adjusts usage snippet formatting/content.

Comment thread nsy2/README.md Outdated
Comment thread yandere/README.md Outdated
Comment thread nsy2/README.md Outdated
Comment thread nsy/README.md Outdated
Comment thread hhss/README.md Outdated
Comment thread hd/README.md Outdated
Comment thread btn/README.md Outdated
@logic-finder

Copy link
Copy Markdown
Contributor Author

done

@logic-finder
logic-finder merged commit 28b2e73 into main Jul 24, 2026
@github-project-automation github-project-automation Bot moved this to Done in Utils Jul 24, 2026
@logic-finder
logic-finder deleted the fix-readmes branch July 24, 2026 03:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

hd readme 수정

3 participants