Skip to content

Conversation

@hartmut-co-uk
Copy link
Contributor

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description, Motivation and Context

Updates the main README file to provide usage instructions and detailed documentation.

πŸ§ͺ How Has This Been Tested?

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@hartmut-co-uk hartmut-co-uk changed the title docs: adds Quick Start instructions and documentation (WIP) docs: adds Quick Start instructions and documentation Sep 18, 2023
@hartmut-co-uk hartmut-co-uk merged commit 5ddd5fd into main Sep 18, 2023
@hartmut-co-uk hartmut-co-uk deleted the feat/readme-add-quick-start-instructions-and-documentation branch September 24, 2023 11:28
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