Skip to content

Commit

Permalink
📝 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Molkobain committed Apr 1, 2019
1 parent 7579874 commit 1559165
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
## Description
Use [Font Awesome 5.7.2](https://fontawesome.com/) new icon sets in both portal & console.

![Description decoration](https://raw.githubusercontent.com/Molkobain/itop-fontawesome5-pack/develop/docs/mfp-icon-examples.PNG)
![Description decoration](docs/mfp-icon-examples.png)

## Compatibility
Compatible with iTop 2.4+
Expand All @@ -25,12 +25,12 @@ Downloading it directly from the *Clone or download* will get you the version un

## Installation
* Unzip the extension
* Copy the ``dist/molkobain-fontawesome5-pack`` folder under ``<PATH_TO_ITOP>/extensions`` folder of your iTop
* Copy the ``molkobain-fontawesome5-pack`` folder under ``<PATH_TO_ITOP>/extensions`` folder of your iTop
* Run iTop setup & select extension *Font Awesome 5*

*Your folders should look like this*

![Extensions folder](https://raw.githubusercontent.com/Molkobain/itop-fontawesome5-pack/develop/docs/mfp-install.PNG)
![Extensions folder](docs/mfp-install.png)

## Configuration
No configuration needed.
Expand All @@ -41,17 +41,17 @@ Let's say that for example you would like to change the *New request* icon with

*XML before*

![Before](https://raw.githubusercontent.com/Molkobain/itop-fontawesome5-pack/develop/docs/mfp-example-01-01.PNG)
![Before](docs/mfp-example-01-01.png)

*XML after*

![After](https://raw.githubusercontent.com/Molkobain/itop-fontawesome5-pack/develop/docs/mfp-example-01-02.PNG)
![After](docs/mfp-example-01-02.png)

Run iTop setup and your portal home page should look like this!

*Result*

![Extensions folder](https://raw.githubusercontent.com/Molkobain/itop-fontawesome5-pack/develop/docs/mfp-example-01-03.PNG)
![Extensions folder](docs/mfp-example-01-03.png)

## Licensing
This extension is under [AGPLv3](https://en.wikipedia.org/wiki/GNU_Affero_General_Public_License).

0 comments on commit 1559165

Please sign in to comment.