|
6 | 6 |  |
7 | 7 | [](https://coveralls.io/github/RipMeApp/ripme?branch=main) |
8 | 8 |
|
| 9 | +## About |
| 10 | + |
| 11 | +RipMe is an album downloader (or "ripper") for various websites. This is a cross-platform tool that runs on *your* computer. Works on Windows, Linux, and Mac. |
| 12 | + |
| 13 | + |
| 14 | + |
9 | 15 | ## Download |
10 | 16 |
|
11 | 17 | Download `ripme.jar` from the [latest release](https://github.com/ripmeapp/ripme/releases/latest). For information about running the `.jar` file, see |
12 | 18 | [the How To Run wiki](https://github.com/ripmeapp/ripme/wiki/How-To-Run-RipMe). |
13 | 19 |
|
| 20 | +## Minimum Requirements |
| 21 | + |
| 22 | +Requires Java 17 or later to run. RipMe has been tested on and is confirmed working on Windows, Linux, and Mac. |
| 23 | + |
| 24 | +Java 17 is the most modern possible Java version that allows us to support the most platforms. See [thread](https://github.com/RipMeApp/ripme/pull/2057#issuecomment-2571472016). |
| 25 | + |
14 | 26 | ## Supported Sites |
15 | 27 |
|
16 | 28 | Jump to: |
@@ -42,13 +54,6 @@ If you'd like to become a maintainer, ask an active maintainer to be added to th |
42 | 54 |
|
43 | 55 | Chat with the team and community on [gitter](https://gitter.im/RipMeApp/Lobby) and [reddit.com/r/ripme](https://www.reddit.com/r/ripme/) |
44 | 56 |
|
45 | | -# About |
46 | | - |
47 | | -RipMe is an album ripper for various websites. It is a cross-platform tool that runs on your computer, and |
48 | | -requires Java 21 or later to run. RipMe has been tested and is confirmed working on Windows, Linux, and MacOS. |
49 | | - |
50 | | - |
51 | | - |
52 | 57 | ## Version Numbers |
53 | 58 |
|
54 | 59 | The version number like `ripme-1.7.94-17-2167aa34-feature_auto_release.jar` contains a release number (`1.7.94`), given by |
@@ -115,7 +120,9 @@ Request support for more sites by adding a comment to [this Github issue](https: |
115 | 120 | If you're a developer, you can add your own Ripper by following the wiki guide: |
116 | 121 | [How To Create A Ripper for HTML Websites](https://github.com/ripmeapp/ripme/wiki/How-To-Create-A-Ripper-for-HTML-websites). |
117 | 122 |
|
118 | | -# Compiling & Building |
| 123 | +# Maintainers |
| 124 | + |
| 125 | +## Compiling & Building |
119 | 126 |
|
120 | 127 | The project uses [Gradle](https://gradle.org). |
121 | 128 |
|
@@ -174,7 +181,7 @@ manual verification of functionality of a work in progress, run the following: |
174 | 181 | The generated JAR (java archive) in build/libs will include all |
175 | 182 | dependencies. |
176 | 183 |
|
177 | | -# Running Tests |
| 184 | +## Running Tests |
178 | 185 |
|
179 | 186 | Tests can be tagged as beeing slow, or flaky. The gradle build reacts to |
180 | 187 | the following combinations of tags: |
@@ -202,6 +209,6 @@ become out of date. Start by building and testing a released version |
202 | 209 | of RipMe and then ensure that any changes you make do not cause more |
203 | 210 | tests to break. |
204 | 211 |
|
205 | | -# Maintainers: How to Publish a New Release |
| 212 | +## Maintainers: How to Publish a New Release |
206 | 213 |
|
207 | 214 | See wiki: [How to Make a New Ripme Release](https://github.com/RipMeApp/ripme/wiki/How-to-make-a-new-ripme-release) |
0 commit comments