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.
- PHP (version 5.4 or higher recommended)
- Permission to create directories and files where specified
To use create_readme.php
, follow these steps:
-
Clone the repository:
git clone https://github.com/Nada-TB/readme-creator-php-script.git
-
Navigate to the directory:
cd your-repository
-
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. -
Follow the on-screen instructions.
- Interactive: Allows you to input the directory path interactively.
- Template-based: Uses a template (
README_template.md
) to create theREADME.md
file. - Flexible: Works across different directories in your development environment.
Contributions are welcome! If you'd like to contribute to create_readme.php
, follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
). - Make your changes.
- Commit your changes (
git commit -am 'Add new feature'
). - Push to the branch (
git push origin feature-branch
). - Create a new Pull Request.
This project is licensed under the MIT License. See the LICENSE file for details.