# Introduction

Welcome to the `readme` project documentation. This project aims to streamline the README experience for GitHub users by providing easy-to-follow guidelines regarding styling and content components. The primary goals are visuals (appeal as well as clarity) paired with ease of use for whoever is viewing your project.\
\
To simplify the adaptation we provide templates over on GitHub allowing you to easily create new projects with a fitting README that can effortlessly be adjusted to your needs:

| Type         | Repository                             |
| ------------ | -------------------------------------- |
| Java project | <https://github.com/etdon/readme-java> |

This documentation consists of a generic section in which more generic guidelines are being provided that can be applied to most projects as well as separated sections for specific project types.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.etdon.com/readme/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.