Skip to content

Commit 25650b2

Browse files
committed
Update README.md
1 parent dd67434 commit 25650b2

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,23 @@ arrays, and other ordered data types).
3232
The GitHub repository is organized as follows:
3333
* The [/build](build) directory contains an ant build file, and other resources related to building the library.
3434
* The [/dist](dist) directory contains the compiled jar files of the library.
35-
* The [/docs](docs) directory contains the javadoc documentation in a sub-directory /docs/api. The /docs directory is also the location of the website for the project hosted via GitHub pages at https://jpt.cicirello.org/.
35+
* The [/docs](docs) directory contains the javadoc documentation in a sub-directory [/docs/api](docs/api). The /docs directory is also the location of the website for the project hosted via GitHub pages at https://jpt.cicirello.org/.
3636
* The [/examples](examples) directory contains several example programs that use the library, and which demonstrate usage of various features.
3737
* The [/replication](replication) directory includes source code that recreates results found in publications associated with the library.
3838
* The [/src](src) directory contains all of the source code.
3939
* The [/tests](tests) directory contains JUnit test cases for all functionality of the library.
4040

41+
## Java 8
42+
43+
The library supports Java 8 or higher, including both Oracle JDK 8 and OpenJDK 8.
44+
45+
## Versioning Scheme
46+
47+
The JPT uses [Semantic Versioning](https://semver.org/) with version
48+
numbers of the form: MAJOR.MINOR.PATCH, where differences in MAJOR
49+
correspond to incompatible API changes, differences in MINOR correspond
50+
to introduction of backwards compatible new functionality, and PATCH
51+
corresponds to backwards compatible bug fixes.
4152

4253
## Building the Library (with ant)
4354

@@ -72,6 +83,36 @@ The replication directory additionally contains more complex examples that repli
7283
experiments from published papers that have used the library. Those directories contain
7384
READMEs that provide more detail on the examples, including on running the examples.
7485

86+
## Importing the Library from Maven Central
87+
88+
Add this to the dependencies section of your pom.xml, replacing the version number
89+
with the version you want to use (note that the library has been available in Maven
90+
Central since version 2.1.2).
91+
92+
```XML
93+
<dependency>
94+
<groupId>org.cicirello</groupId>
95+
<artifactId>jpt</artifactId>
96+
<version>2.1.2</version>
97+
</dependency>
98+
```
99+
100+
## Importing the Library from Github Packages
101+
102+
If you'd prefer to import from Github Packages, rather than Maven Central,
103+
then: (1) add the dependency as indicated in previous section above,
104+
and (2) add the following to the repositories section of your pom.xml:
105+
106+
```XML
107+
<repository>
108+
<id>github</id>
109+
<name>GitHub cicirello Apache Maven Packages</name>
110+
<url>https://maven.pkg.github.com/cicirello/JavaPermutationTools</url>
111+
<releases><enabled>true</enabled></releases>
112+
<snapshots><enabled>true</enabled></snapshots>
113+
</repository>
114+
```
115+
75116
## Contribute
76117

77118
Report bugs, suggestions, feature requests, etc via the [issues tracker](https://github.com/cicirello/JavaPermutationTools/issues). If you would

0 commit comments

Comments
 (0)