/skeleton

Generates default project files (README.md, CONTRIBUTING.md, LICENSE, etc) at the root of your project

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

jawira/skeleton

The jawira/skeleton library creates useful files that are recurrently needed in projects (e.g. README.md, .gitignore, build.xml, etc).

asciicast

Latest Stable Version License composer.lock PDS Skeleton Issues HitCount

How to install

Install this package with Composer:

$ composer require jawira/skeleton:*

Usage

  1. Run the executable:

    $ vendor/bin/jawira-skeleton
  2. Select the files you want to create with (space key).

  3. Start copying selected files with (enter key).

Skeleton files

Skeleton files are located at resources/warehouse/.

Currently the following files can be installed trough executable:

resources/warehouse/
├── build.xml
├── CHANGELOG.md
├── .codeclimate.yml
├── CODE_OF_CONDUCT.md
├── .composer.json
├── CONTRIBUTING.md
├── docker-compose.yml
├── Dockerfile
├── .editorconfig
├── gitattributes
├── gitignore
├── LICENSE.md
├── Makefile
├── .makerc.dist
├── phive.xml
├── .README.md
├── resources
│   ├── make
│   │   └── phar.mk
│   └── phing
│       ├── apache2.build.xml
│       ├── changelog.build.xml
│       ├── clamav.build.xml
│       ├── code-climate.build.xml
│       ├── composer.build.xml
│       ├── docker-compose.build.xml
│       ├── git.build.xml
│       ├── open.build.xml
│       ├── php.build.xml
│       ├── phpstan.build.xml
│       ├── portainer.build.xml
│       └── xdebug.build.xml
└── .travis.yml

3 directories, 30 files

Note all files are customized according to my personal needs.

Contributing

To contribute to this project please read CONTRIBUTING.md first.

License

This project is under the GNU GPLv3 license.