|
16 | 16 |
|
17 | 17 | ## **"Some" Utilities you can use for your `Java` projects "*freely*"!** |
18 | 18 |
|
19 | | -# :arrow_down: **How To Install** :heavy_plus_sign: |
| 19 | +\***Coughs**\* *"freely"* in the sense that you still need to include the [**`license`**](./LICENSE) into your program. |
| 20 | + |
| 21 | +Files are **`compiled`** with **`Java-8`** and above, but mostly **`Java-11`**. |
| 22 | + |
| 23 | +--- |
| 24 | + |
| 25 | +# :heavy_plus_sign: **Features** :triangular_flag_on_post: |
| 26 | +[Contributing.md](https://github.com/JumperBot/Java-SomeUtils/blob/master/.github/CONTRIBUTING.md/#navigating-the-repository) has a large ***(to very large)*** section or division just for this! |
| 27 | + |
| 28 | +**[`This repository`](https://github.com/JumperBot/Java-SomeUtils/) has common/uncommon`utilities`** you can use for your program! |
| 29 | + |
| 30 | +You may use any class you can find as long as you include the [**`license`**](./LICENSE). |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +# :truck: **How To Install** :arrow_down: |
20 | 35 |
|
21 | 36 | ```shell |
22 | 37 | git clone https://github.com/JumperBot/SomeUtils.git |
23 | 38 | cp $HOME"/Java-SomeUtils/build/*" "/Your/Project/src/" |
24 | 39 | cp $HOME"/Java-SomeUtils/LICENSE" "/Your/Project/src/SomeUtils/" |
25 | 40 | ``` |
26 | 41 |
|
| 42 | +--- |
| 43 | + |
27 | 44 | # :wrench: **How To Use** :hammer: |
28 | 45 |
|
29 | 46 | **Import** a **`class`** using: |
|
32 | 49 | import SomeUtils.WhatYouNeed.WhatYouNeed; |
33 | 50 | ``` |
34 | 51 |
|
| 52 | +A **`documentation`** for each class is included in it's own [**`src/`**](./src/SomeUtils) subdirectory. |
| 53 | + |
35 | 54 | A **`demo`** is **included** in each class, **check them out** before using them! |
36 | 55 |
|
37 | 56 | --- |
38 | 57 |
|
39 | 58 | # :building_construction: Contributing :speech_balloon: |
40 | 59 |
|
41 | | -[**Community Contribution**](./.github/CONTRIBUTING.md) is **welcome** in this repository. |
| 60 | +[**`Community Contribution`**](./.github/CONTRIBUTING.md) is **welcome** in this repository. |
42 | 61 |
|
43 | | -You may **use anything** in this repository as long as you include the [**license**](./LICENSE). |
| 62 | +As long as you **don't ignore** the [**`Code Of Conduct`**](https://github.com/JumperBot/Java-SomeUtils/blob/master/.github/CODE_OF_CONDUCT.md) and [**`some extra guidelines`**](./.github/CONTRIBUTING.md)! |
44 | 63 |
|
45 | 64 | --- |
46 | 65 |
|
47 | 66 | # :busts_in_silhouette: Contributors :monocle_face: |
48 | 67 |
|
49 | 68 | <img src="https://contrib.rocks/image?repo=JumperBot/Java-SomeUtils"></img> |
50 | 69 |
|
51 | | -</div> |
| 70 | +</div> |
0 commit comments