mirror of
https://github.com/anas-elgarhy/JColorfulConsole.git
synced 2024-08-14 23:57:19 +00:00
update the readme file
This commit is contained in:
parent
f2b21cfb6b
commit
a4de946e6e
1 changed files with 37 additions and 15 deletions
48
README.md
48
README.md
|
@ -12,29 +12,47 @@
|
||||||
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole)
|
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole)
|
||||||
|
|
||||||
## Features:
|
## Features:
|
||||||
- Support text color.
|
|
||||||
- Support background color.
|
- Support text color.
|
||||||
- Support 256 colors (RGB).
|
- Support background color.
|
||||||
- Support ANSI colors.
|
- Support 256 colors (RGB).
|
||||||
- Support indexed colors.
|
- Support ANSI colors.
|
||||||
- Support text style.
|
- Support indexed colors.
|
||||||
- Lightweight and fast.
|
- Support text style.
|
||||||
- Easy to use.
|
- Lightweight and fast.
|
||||||
|
- Easy to use.
|
||||||
|
|
||||||
## How to add this library into your project
|
## How to add this library into your project
|
||||||
|
|
||||||
### Maven
|
### Maven
|
||||||
**Step 1**. Add the dependency
|
|
||||||
|
**Step 1**. Add the JitPack repository to your build file
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
|
<repositories>
|
||||||
|
<repository>
|
||||||
|
<id>jitpack.io</id>
|
||||||
|
<url>https://jitpack.io</url>
|
||||||
|
</repository>
|
||||||
|
</repositories>
|
||||||
|
```
|
||||||
|
|
||||||
|
**Step 2**. Add the dependency
|
||||||
|
|
||||||
|
```xml
|
||||||
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.anas.jcolorfulconsole</groupId>
|
<groupId>com.anas.jcolorfulconsole</groupId>
|
||||||
<artifactId>jcolorfulconsole</artifactId>
|
<artifactId>jcolorfulconsole</artifactId>
|
||||||
<version>1.0.1</version>
|
<version>1.0.2</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Gradle:
|
#### Gradle:
|
||||||
|
|
||||||
**Step 1**. Add the JitPack repository to your build file<br>
|
**Step 1**. Add the JitPack repository to your build file<br>
|
||||||
*Add it in your root build.gradle at the end of repositories:*
|
*Add it in your root build.gradle at the end of repositories:*
|
||||||
|
|
||||||
```gradle
|
```gradle
|
||||||
allprojects {
|
allprojects {
|
||||||
repositories {
|
repositories {
|
||||||
|
@ -43,10 +61,12 @@ allprojects {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Step 2**. Add the dependency
|
**Step 2**. Add the dependency
|
||||||
|
|
||||||
```gradle
|
```gradle
|
||||||
dependencies {
|
dependencies {
|
||||||
implementation 'com.github.Anas-Elgarhy:JColorfulConsole:1.0.1'
|
implementation 'com.github.Anas-Elgarhy:JColorfulConsole:1.0.2'
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -72,6 +92,7 @@ public class Example1 {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
![Result of example 1](./Screenshots/1.0.1-example1.png)
|
![Result of example 1](./Screenshots/1.0.1-example1.png)
|
||||||
|
|
||||||
```java
|
```java
|
||||||
|
@ -93,14 +114,17 @@ public class Example2 {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
![Result of example 2](./Screenshots/1.0.1-example2.gif)
|
![Result of example 2](./Screenshots/1.0.1-example2.gif)
|
||||||
|
|
||||||
## Requirements for development:
|
## Requirements for development:
|
||||||
|
|
||||||
- Maven
|
- Maven
|
||||||
- jdk 17
|
- jdk 17
|
||||||
- IntelliJ IDEA (not required but recommended)
|
- IntelliJ IDEA (not required but recommended)
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- [ ] Add Tests
|
- [ ] Add Tests
|
||||||
- [ ] Add Formatter
|
- [ ] Add Formatter
|
||||||
- [ ] Add Documentation
|
- [ ] Add Documentation
|
||||||
|
@ -113,10 +137,8 @@ public class Example2 {
|
||||||
[![BitBucket](https://img.shields.io/badge/BitBucket-Mirror%20repo-brightgreen?style=for-the-badge&logo=BitBucket)](https://bitbucket.org/anas_elgarhy/jcolorfulconsole)
|
[![BitBucket](https://img.shields.io/badge/BitBucket-Mirror%20repo-brightgreen?style=for-the-badge&logo=BitBucket)](https://bitbucket.org/anas_elgarhy/jcolorfulconsole)
|
||||||
[![Codeberg](https://img.shields.io/badge/Codeberg-Mirror%20repo-brightgreen?style=for-the-badge&logo=Codeberg)](https://codeberg.org/anas-elgarhy/JColorfulConsole)
|
[![Codeberg](https://img.shields.io/badge/Codeberg-Mirror%20repo-brightgreen?style=for-the-badge&logo=Codeberg)](https://codeberg.org/anas-elgarhy/JColorfulConsole)
|
||||||
|
|
||||||
|
|
||||||
[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=Anas-Elgarhy_JColorfulConsole)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole)
|
[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=Anas-Elgarhy_JColorfulConsole)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole)
|
||||||
|
|
||||||
|
|
||||||
[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-black.svg)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole)
|
[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-black.svg)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole)
|
||||||
|
|
||||||
![License: GPL-3.0](https://img.shields.io/badge/License-GPL%203.0-blue.svg)
|
![License: GPL-3.0](https://img.shields.io/badge/License-GPL%203.0-blue.svg)
|
||||||
|
|
Loading…
Reference in a new issue