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
32
README.md
32
README.md
|
@ -12,6 +12,7 @@
|
|||
[](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole)
|
||||
|
||||
## Features:
|
||||
|
||||
- Support text color.
|
||||
- Support background color.
|
||||
- Support 256 colors (RGB).
|
||||
|
@ -22,19 +23,36 @@
|
|||
- Easy to use.
|
||||
|
||||
## How to add this library into your project
|
||||
|
||||
### Maven
|
||||
**Step 1**. Add the dependency
|
||||
|
||||
**Step 1**. Add the JitPack repository to your build file
|
||||
|
||||
```xml
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>jitpack.io</id>
|
||||
<url>https://jitpack.io</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
```
|
||||
|
||||
**Step 2**. Add the dependency
|
||||
|
||||
```xml
|
||||
|
||||
<dependency>
|
||||
<groupId>com.anas.jcolorfulconsole</groupId>
|
||||
<artifactId>jcolorfulconsole</artifactId>
|
||||
<version>1.0.1</version>
|
||||
<version>1.0.2</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
#### Gradle:
|
||||
|
||||
**Step 1**. Add the JitPack repository to your build file<br>
|
||||
*Add it in your root build.gradle at the end of repositories:*
|
||||
|
||||
```gradle
|
||||
allprojects {
|
||||
repositories {
|
||||
|
@ -43,10 +61,12 @@ allprojects {
|
|||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Step 2**. Add the dependency
|
||||
|
||||
```gradle
|
||||
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 {
|
|||
}
|
||||
}
|
||||
```
|
||||
|
||||

|
||||
|
||||
```java
|
||||
|
@ -93,14 +114,17 @@ public class Example2 {
|
|||
}
|
||||
}
|
||||
```
|
||||
|
||||

|
||||
|
||||
## Requirements for development:
|
||||
|
||||
- Maven
|
||||
- jdk 17
|
||||
- IntelliJ IDEA (not required but recommended)
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] Add Tests
|
||||
- [ ] Add Formatter
|
||||
- [ ] Add Documentation
|
||||
|
@ -113,10 +137,8 @@ public class Example2 {
|
|||
[](https://bitbucket.org/anas_elgarhy/jcolorfulconsole)
|
||||
[](https://codeberg.org/anas-elgarhy/JColorfulConsole)
|
||||
|
||||
|
||||
[](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole)
|
||||
|
||||
|
||||
[](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole)
|
||||
|
||||

|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue