-
Notifications
You must be signed in to change notification settings - Fork 279
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 6f79118
Showing
1 changed file
with
63 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# WHMCS Six Client Area Template Theme | ||
|
||
Welcome to the WHMCS “Six” template repository! This repository is dedicated to providing version-by-version changes of the “Six” template as published in [WHMCS](https://downloads.whmcs.com/). Sharing these changes through GitHub as a read-only repository enables you to quick inspect and import these changes for your custom theme. | ||
|
||
## Compatibility | ||
|
||
This theme is compatible with WHMCS 6.0 and later. | ||
|
||
## Usage | ||
|
||
You can utilise this repository to see the individual changes to this theme as distributed in WHMCS. | ||
|
||
You can also use it to build your template in a way that can be controlled using Version Control, with the ability to pull in and auto-merge future changes. | ||
|
||
You may fork this repository as described in the | ||
[GitHub Guide: Forking Projects](https://guides.github.com/activities/forking/) or | ||
[GitHub Bootcamp: Forking a Repo](https://help.github.com/articles/fork-a-repo/) articles. | ||
|
||
### Command Line Usage | ||
|
||
The below is an example of how you might check this repository out locally into a custom folder and create a branch for building and tracking the changes for your custom theme: | ||
|
||
```sh | ||
# Navigate to your WHMCS templates directory | ||
cd ~/whmcs/templates/ | ||
|
||
# Clone the Six template theme repo into your new template directory | ||
git clone git@github.com:WHMCS/templates-six.git my-template-name | ||
|
||
# Change directory to the template directory | ||
cd my-template-name | ||
|
||
# Create a custom branch to make and commit your customisations into | ||
git checkout -b my-template-name | ||
``` | ||
|
||
When an update of WHMCS is published, the template changes will be propagated to this repository. You can then pull those changes into your custom template branch as follows: | ||
|
||
```sh | ||
# Navigate to the template directory | ||
cd ~/whmcs/templates/my-template-name | ||
|
||
# Fetch the latest updates from the Six template theme repo | ||
git fetch origin | ||
|
||
# Ensure your custom template branch is checked out | ||
git checkout my-template-name | ||
|
||
# Merge changes from origin/master into your custom branch | ||
git merge origin/master | ||
``` | ||
|
||
## Viewing the Template Changes | ||
|
||
A distinct tag is created for each published version of WHMCS. You can easily view | ||
any span of changes you like using the [Github Comparison View](https://github.com/WHMCS/templates-six/compare). | ||
Simply, select a pair of version tags in that interface! | ||
|
||
## Useful Links | ||
|
||
* [Documentation](http://docs.whmcs.com/Customising_the_Six_Theme) | ||
* [Technical Support](http://www.whmcs.com/support) | ||
* [WHMCS Website](http://www.whmcs.com/) |