Skip to content

PHP script that allows you to dynamically create a README.md file based on a template

License

Notifications You must be signed in to change notification settings

Nada-TB/readme-creator-php-script

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

create_readme.php

create_readme.php is a PHP script that allows you to dynamically create a README.md file based on a template. This script provides flexibility by letting you specify the directory where the README.md file should be created.

Table of Contents

Requirements

  • PHP (version 5.4 or higher recommended)
  • Permission to create directories and files where specified

Installation

To use create_readme.php, follow these steps:

  1. Clone the repository:

    git clone https://github.com/Nada-TB/readme-creator-php-script.git
  2. Navigate to the directory:

    cd your-repository

Usage

  1. Run the script:

    php create_readme.php

    The script will prompt you to enter the directory path where you want to create the README.md file.

  2. Follow the on-screen instructions.

Features

  • Interactive: Allows you to input the directory path interactively.
  • Template-based: Uses a template (README_template.md) to create the README.md file.
  • Flexible: Works across different directories in your development environment.

Contributing

Contributions are welcome! If you'd like to contribute to create_readme.php, follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to the branch (git push origin feature-branch).
  6. Create a new Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.


About

PHP script that allows you to dynamically create a README.md file based on a template

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages