Skip to content

docs: unify README, setup guide, and description - #3

Merged
Firestone82 merged 2 commits into
masterfrom
docs/unify-readme
Jun 20, 2026
Merged

docs: unify README, setup guide, and description#3
Firestone82 merged 2 commits into
masterfrom
docs/unify-readme

Conversation

@Firestone82

Copy link
Copy Markdown
Owner

Standardizes the README format and updates the repository description for consistency across all public repositories.

Changes:

  • Unified section structure: About, Features, Requirements, Setup, Configuration (where applicable), License
  • School projects clearly marked with VŠB-TUO attribution and course name/code
  • Personal projects updated with accurate descriptions and real config examples
  • Repository description updated

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8a89281bc8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md

3. Run a program:
```bash
java -jar target/ParsingCompiler-*.jar path/to/program.lang

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Correct the advertised run command

Users who follow this command will not run the requested program: the Maven build is configured with artifactId ProjectANTLR, so this glob does not match the produced jar name, and Main.main ignores args while always constructing Path.of("Project/PLC_test.in.txt"), which Program then resolves under src/main/antlr4. Either document the actual invocation/default sample or update the CLI before advertising path/to/program.lang.

Useful? React with 👍 / 👎.

@Firestone82
Firestone82 merged commit 6a28b94 into master Jun 20, 2026
3 checks passed
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.

1 participant