New Project Readme

README.md

Project Name

Short Description

Table of Contents

• Folder Structure
• Development
  • Installing
• Production
  • Releases
• Todo

Folder Structure.

project-name/
_____________________________
|-- assets/
|   |-- images/
|   |   `-- favicons/
|   |-- js
|   |-- sass
|   `-- media/
|-- core/
|   |-- assets/
|   |-- project-name-activation.php
|   |-- project-name-functions.php
|   `-- project-name-settings.php
|-- CHANGELOG.md
|-- LICENSE.md
`-- README.md

** For a print out like the above you can use the shell script below **

#!/bin/bash

SEDMAGIC='s;[^/]*/;|____;g;s;____|; |;g'

if [ "$#" -gt 0 ] ; then
   dirlist="$@"
else
   dirlist="."
fi

for x in $dirlist; do
     find "$x" -print | sed -e "$SEDMAGIC"
done

Development

Project Development description.

Installing

Project Development installation description.

Production

Production description.

Releases

Production Releases description.

TODO

• TODO list item
• TODO list item
• TODO list item