Adding README.md file

Updating the version to be able to create a fork from the latest version.

Thanks everyone, it looks good. I updated the formatting to Markdown format following the README.md template → and created a merge request in Gitlab (2878723-3.2.x-adding-readme.md-file, please ignore 2878723-adding-readme.md-file).

The only thing I added was a note that the admin user (#1) needs to have permissions added actively.

Also, the configuration may have changed since May 2021, so please review the steps under Configuration.

sourabhjain → closed merge request !108

Relative path shouldn't be rendered as code

I see many modules formatting paths like that ... Is this your personal opinion? I don't see it mentioned on README.md template → .

If anything, a slash should be added, to align all paths:

(admin/group/types)
should be
(/admin/group/types)

To align with for example (/admin/group/types/manage/school/fields).

Is this your personal opinion?

Thank you for bringing up the question. While I understand that some modules may use backticks for paths, the convention in Markdown is to reserve backticks for indicating inline code or code blocks. In this context, it's more appropriate to use a different formatting style for relative paths, such as simply stating the path or using italics. This helps maintain consistency and clarity in the documentation. If it's a common practice in this module, it might be worth considering an update for better readability.

Thanks for clarifying. A lot of README's also use code mark up for Twig files, there's even an example on the README template page, and marking up paths and file names with backticks is a very common thing ...

But it could a topic for a more general discussion about adding a guideline in README.md template → , so feel free to propose that in https://www.drupal.org/node/2181737/discuss → .

Thank you for considering a broader discussion on adding guidelines to the README.md template. It would be beneficial to establish a consistent approach for marking up paths and file names.
I'd be happy to post this. I believe gathering input from the community will help us define best practices that enhance the overall readability and consistency of the documentation.

Hi thakurnishant_06

I've reviewed your changes and noticed that Project name and introduction is missing a link to the project page and issue queue. This is the format of the project page and issue queue based on README.md template. →

For a full description of the module, visit the
[project page](https://www.drupal.org/project/admin_menu).

Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/admin_menu).

Thank you.

MR updated with the required changes, thanks!