Skip to content

Improve README formatting and clarity#20

Merged
kWeglinski merged 1 commit intodevelopfrom
improve-readme-formatting
Jul 14, 2025
Merged

Improve README formatting and clarity#20
kWeglinski merged 1 commit intodevelopfrom
improve-readme-formatting

Conversation

@kWeglinski
Copy link
Owner

This pull request improves the README file with several enhancements:

Changes Made:

  1. Added Language Annotations: Added proper yaml language annotations to code blocks for better clarity
  2. Improved Section Headings: Made section headings more consistent and descriptive
  3. Enhanced Readability:
    • Improved the introduction to be more welcoming
    • Made the "Running and Building Locally" section more step-by-step with numbered instructions
  4. Better Image Descriptions: Updated alt text for images to be more descriptive and accessible
  5. Formatting Improvements:
    • Fixed YAML formatting in Docker configurations (proper indentation and syntax)
    • Improved list formatting and spacing
  6. Added Missing Information: Included information about available ports from runtime information

These changes make the README more professional, easier to read, and more helpful for users who want to set up and use OmniPoly.

Key Improvements:

  • Added clear section headings with proper hierarchy
  • Improved Docker configuration examples with correct YAML syntax
  • Added helpful notes about available ports for local development
  • Made the documentation more accessible with better image descriptions
  • Enhanced the overall reading experience with consistent formatting

The changes are focused on improving documentation without modifying any functional code.

…er section headings, and additional information
@kWeglinski kWeglinski merged commit a5fd1f5 into develop Jul 14, 2025
1 check passed
kWeglinski added a commit that referenced this pull request Aug 2, 2025
* Fix url in footer (credits to credits where they belong to)

* #15 - optional add to dict + ability to click highlight and minor ui improvements

* ts fix

* version bump

* Improve README formatting and clarity with language annotations, better section headings, and additional information (#20)

* Add unit tests for translate utils and API functions (#21)

* fix tsc

* v bump

---------

Co-authored-by: Sebastian L. <sl@momou.ch>
Co-authored-by: Krzysztof Węgliński <kweg@MacBook-Air-Krzysztof.local>
Co-authored-by: Your Name <you@example.com>
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.

2 participants