The repository 'rstoetter/mk-new-repository.sh'

Index

Description

Requirements

Use Cases

Provided Files and Directories

Installation

More Informations

Description

bash script, which creates a skeleton directory with the necessary bunch of files for a fresh github PHP repository

Requirements

make sure, that you are running a bash version >= 4.4

bash --version

Use Cases

What you should have done before executing the bash script mk-new-repository.sh

• create a new EMPTY ( no files! ) repository on github
• save the first wiki page

executing the bash script mk-new-repository.sh

mk-new-repository.sh vendor_string repository_name namespace class_name

• the first parameter is the vendor string on github (your username) ie: 'rstoetter'"
• the second parameter is the name the new repository ie: 'cdependencymanager-php'"
• the third parameter is the name of the namespace ie: 'cdependencymanager'"
• the fourth parameter is the name of the main class provided by your repository ie: 'myClass'"

The bash script will then create a directory withe the name 'repository_name' and fill it with files and directories you may find useful in order to start your new project

Provided Files and Directories

<RepositoryName>
├── ./CHANGELOG.md
├── ./composer.json
├── ./git-add.sh
├── ./git-push-<RepositoryName>.sh
├── ./git-revision.sh
├── ./LICENSE
├── ./phpdoc-make-md-<RepositoryName>.sh
├── ./phpdocmd.sh
├── ./phpdoc-<RepositoryName>.cfg
├── ./phpdoc-<RepositoryName>.sh
├── ./phpdoc.sh
├── ./phpDocumentor.xref
├── ./phpunit.xml
├── ./README.md
├── ./src
├── ./tests
└── ./wiki
    ├── ./wiki/git-clone-documentation.sh
    └── ./wiki/<RepositoryName>.wiki
        ├── ./wiki/<RepositoryName>.wiki/English-Documentation.md
        ├── ./wiki/<RepositoryName>.wiki/English-Reference.md
        ├── ./wiki/<RepositoryName>.wiki/_Footer.md
        ├── ./wiki/<RepositoryName>.wiki/git-add.sh
        ├── ./wiki/<RepositoryName>.wiki/git-push-wiki-<RepositoryName>.sh
        ├── ./wiki/<RepositoryName>.wiki/git-update-documentation.sh
        └── ./wiki/<RepositoryName>.wiki/Home.md

Installation

git clone https://github.com/rstoetter/mk-new-repository.sh.git

More Information

See the project wiki of rstoetter/mk-new-repository.sh for more technical informations.