Skip to content

Commit e2c7cfc

Browse files
authored
Update README.md - Update info about Java 17. Think about what info is immediately presented to a new user.
1 parent bac4774 commit e2c7cfc

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,23 @@
66
![alt Badge Status](https://github.com/ripmeapp/ripme/actions/workflows/gradle.yml/badge.svg)
77
[![Coverage Status](https://coveralls.io/repos/github/RipMeApp/ripme/badge.svg?branch=main)](https://coveralls.io/github/RipMeApp/ripme?branch=main)
88

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+
![Screenshot](https://i.imgur.com/UCQNjeg.png)
14+
915
## Download
1016

1117
Download `ripme.jar` from the [latest release](https://github.com/ripmeapp/ripme/releases/latest). For information about running the `.jar` file, see
1218
[the How To Run wiki](https://github.com/ripmeapp/ripme/wiki/How-To-Run-RipMe).
1319

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+
1426
## Supported Sites
1527

1628
Jump to:
@@ -42,13 +54,6 @@ If you'd like to become a maintainer, ask an active maintainer to be added to th
4254

4355
Chat with the team and community on [gitter](https://gitter.im/RipMeApp/Lobby) and [reddit.com/r/ripme](https://www.reddit.com/r/ripme/)
4456

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-
![Screenshot](https://i.imgur.com/UCQNjeg.png)
51-
5257
## Version Numbers
5358

5459
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:
115120
If you're a developer, you can add your own Ripper by following the wiki guide:
116121
[How To Create A Ripper for HTML Websites](https://github.com/ripmeapp/ripme/wiki/How-To-Create-A-Ripper-for-HTML-websites).
117122

118-
# Compiling & Building
123+
# Maintainers
124+
125+
## Compiling & Building
119126

120127
The project uses [Gradle](https://gradle.org).
121128

@@ -174,7 +181,7 @@ manual verification of functionality of a work in progress, run the following:
174181
The generated JAR (java archive) in build/libs will include all
175182
dependencies.
176183

177-
# Running Tests
184+
## Running Tests
178185

179186
Tests can be tagged as beeing slow, or flaky. The gradle build reacts to
180187
the following combinations of tags:
@@ -202,6 +209,6 @@ become out of date. Start by building and testing a released version
202209
of RipMe and then ensure that any changes you make do not cause more
203210
tests to break.
204211

205-
# Maintainers: How to Publish a New Release
212+
## Maintainers: How to Publish a New Release
206213

207214
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

Comments
 (0)