Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Freezor/fix readme formatting spelling andstructure #252

Conversation

Freezor
Copy link
Contributor

@Freezor Freezor commented May 29, 2024

Description

This PR updates the README.md file with improved formatting, corrected URLs, and additional information. It enhances readability and provides clearer instructions for users.

Motivation and Context

The changes are necessary to ensure that users can easily understand how to use the AASX Server and its related functionalities. By fixing broken URLs, adding missing information, and rephrasing certain sections, this update aims to improve the overall user experience.

Type of change

  • This change is a documentation update

How Has This Been Tested?

The changes have been reviewed locally to ensure that they render correctly in markdown format. No functional changes have been made, so testing is not applicable.

Checklist:

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

@Freezor Freezor self-assigned this May 29, 2024
@Freezor Freezor merged commit 7fdd464 into eclipse-aaspe:main May 29, 2024
1 check passed
@Freezor Freezor mentioned this pull request May 29, 2024
@Freezor Freezor deleted the freezor/fix-readme-formatting-spelling-andstructure branch June 3, 2024 09:02
@Freezor Freezor added the ignore Used to flag issues or pull requests that will be ignored on the changelog generation. label Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore Used to flag issues or pull requests that will be ignored on the changelog generation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant