Legoktm has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/405918 )
Change subject: Generate a README.md file ...................................................................... Generate a README.md file This is based off of the one from the CDB library. Change-Id: I61a0d897b5431a71bede4d5e09cf17ec58ffa774 --- M hooks/post_gen_project.py A {{ cookiecutter.library_name }}/README.md 2 files changed, 53 insertions(+), 8 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/tools/cookiecutter-library refs/changes/18/405918/1 diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index a7bbe8a..0e0aa13 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -57,13 +57,18 @@ return new -with open('composer.json', 'r') as f: - text = f.read() +def replace_composer_name(fname): + with open(fname, 'r') as f: + text = f.read() -text = text.replace( - '!!COMPOSER_NAME!!', - 'wikimedia/' + composerify_name(library_name) -) + text = text.replace( + '!!COMPOSER_NAME!!', + 'wikimedia/' + composerify_name(library_name) + ) -with open('composer.json', 'w') as f: - f.write(text) + with open(fname, 'w') as f: + f.write(text) + + +replace_composer_name('composer.json') +replace_composer_name('README.md') diff --git "a/\173\173 cookiecutter.library_name \175\175/README.md" "b/\173\173 cookiecutter.library_name \175\175/README.md" new file mode 100644 index 0000000..8587b73 --- /dev/null +++ "b/\173\173 cookiecutter.library_name \175\175/README.md" @@ -0,0 +1,40 @@ +[![Latest Stable Version]](https://packagist.org/packages/!!COMPOSER_NAME!!) [![License]](https://packagist.org/packages/!!COMPOSER_NAME!!) + +{{ cookiecutter.library_name }} +===================== + +FILL THIS IN + +Additional documentation about the library can be found on +[MediaWiki.org](https://www.mediawiki.org/wiki/{{ cookiecutter.library_name }}). + + +Usage +----- + + // Fill this in + + +Running tests +------------- + + composer install --prefer-dist + composer test + + +History +------- + +Review and update this section. +This library was first introduced in [MediaWiki 1.16][] ([r52203][]). It was +split out of the MediaWiki codebase and published as an independent library +during the [MediaWiki 1.25][] development cycle. + + +--- +[MediaWiki 1.16]: https://www.mediawiki.org/wiki/MediaWiki_1.16 +[r52203]: https://www.mediawiki.org/wiki/Special:Code/MediaWiki/52203 +[MediaWiki 1.25]: https://www.mediawiki.org/wiki/MediaWiki_1.25 +[Latest Stable Version]: https://poser.pugx.org/!!COMPOSER_NAME!!/v/stable.svg +[License]: https://poser.pugx.org/!!COMPOSER_NAME!!/license.svg + -- To view, visit https://gerrit.wikimedia.org/r/405918 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I61a0d897b5431a71bede4d5e09cf17ec58ffa774 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/tools/cookiecutter-library Gerrit-Branch: master Gerrit-Owner: Legoktm <lego...@member.fsf.org> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits