Skip to content

Commit 21e79ba

Browse files
Updated the README with Gradle, Jitpack and Testing info
1 parent 5716807 commit 21e79ba

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,27 @@ CSSBox relies on the jStyleParser open source CSS parser
1818

1919
The CSSBox library is under development and its API or functionality may change in future versions.
2020
See the CHANGELOG for the most important changes to the previous versions.
21+
22+
Gradle and Jitpack support
23+
--------------------------
24+
25+
This project now supports Gradle and Jitpack. After making a change, create a new release using the x.x.x format
26+
(See: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
27+
28+
If using in conjunction with CSSBox, you will then also need to update CSSBox's build.gradle.kts file and increment the version of jStyleParser
29+
with the new version number.
30+
31+
Test Suite files
32+
--------------------------
33+
34+
The CSSBox unit tests require many files to run correctly, all of which can be found at https://github.com/radkovo/CSSBoxTesting/
35+
36+
Due to how many test files there are, importing them manually and attempting to build can crash some IDEs like Eclipse. in these cases bulding via a CLI is needed.
37+
38+
These tests are imported and run using Github Actions, and so are not needed in this repository. To run these tests locally, create a directory called "testsuite" in the root,
39+
and place the "baseline" folder from the CSSBoxTesting repo inside. Your directory should look like this:
40+
```
41+
CSSBox/testsuite/baseline/nightly-unstable/html4/...
42+
```
43+
When the test files files are absent the tests will not run locally.
44+

0 commit comments

Comments
 (0)