drutopia/writeme

Create and keep updated a README.md for your project, fetching details from composer.json and Git. Composer does not need to be installed to use this tool.

dev-dev-master 2025-01-15 12:47 UTC

Requires

• php: >=5.3.6

GPL-2.0+

• Benjamin Melançon (mlncn)

• documentation
• php
• composer
• utility
• script
• readme

README

Writeme

Create and keep updated a README.md for your project, fetching details from composer.json and Git. Composer does not need to be installed to use this tool.

• http://gitlab.com/drutopia/writeme
• Documentation: https://docs.drutopia.org/
• Issues: http://gitlab.com/drutopia/writeme/issues
• Keywords: readme, composer, php, documentation, utility, script
• Package name: drutopia/writeme

Maintainers

• Benjamin Melançon (mlncn) - http://agaric.coop/mlncn

Requirements

• php >=5.3.6

License

GPL-2.0+: GNU General Public License, version 2 or later

Usage

php path/to/writeme/src/writeme.php

Or add an alias to the path to make it easy to use anytime you are next to a composer.json from which you would like to generate a README.md file. For example, in my .bashrc i have:

alias writeme='php ~/Projects/drutopia/writeme/src/writeme.php'

Background

Inspired by but no longer containing any code from docbloc.