Welcome to the WordPress project repository! This repository contains the files and documentation necessary for developing, deploying, and maintaining a custom WordPress theme for our client. This README provides a basic overview of the project and links to other documentation files for more detailed information.
- /theme/: Contains the custom WordPress theme files.
- /assets/: Contains images, CSS, and JavaScript files.
- /docs/: Contains documentation files.
Detailed documentation to help developers and site maintainers can be found in the following files:
- deployment.md: Detailed workflow for developing and deploying the theme.
- theme.md: Information about the theme's features, files, and customization options.
- site.md: Instructions for the client's site maintainer on how to manage and update the site.
- WordPress installation
- Local development environment (e.g., VVV, XAMPP)
- Git
- Clone the repository:
git clone [repository-url]
- Navigate to the theme directory:
cd [theme-directory] - Activate the theme in the WordPress admin panel.:
- Set up the local development environment using VVV.:
- install VirtualBox and Vagrant.
- Configure VVV as per the official documentation.
- Clone the theme repository:
git clone [repository-url]
- Activate the theme in the WordPress admin panel.:
We welcome contributions to improve this project. To contribute:
- Fork the repository.
- Create a new branch for your feature or bugfix:
git checkout -b feature-name
- Commit your changes:
git commit -m "Description of feature or fix" - Push to the branch:
git push origin feature-name
- Open a pull request.