Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 56 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,57 @@
build
bin
tmp
pattypan.jar
# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

# MAVEN #
target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties
dependency-reduced-pom.xml
buildNumber.properties

# ECLIPSE #
.classpath
.project
.settings/

# IDEA #
# Ignores are handled by the JetBrains .gitignore plugin or included in the default .gitignore if using "Add to VCS"
# *.iml
# *.ipr
# *.iws
.idea/

# NetBeans #
nbproject/private/
build/
nbbuild/
dist/
nbdist/
nbactions.xml
*.nbattrs

# VS Code #
.vscode/
36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,46 @@ __[:arrow_down: Download](https://github.com/yarl/pattypan/releases)__
----

### Build and run
[Apache Ant](https://ant.apache.org/) is used for building Pattypan. You need to have JDK 11 or later installed as well as [a download of OpenJFX](https://gluonhq.com/products/javafx/) for each platform you want to support. In order to download and build source code, do the following:
[Apache Maven](https://maven.apache.org/) is used for building Pattypan. You need to have JDK 11 or later installed as well as Maven.

```
In order to download the source code, build, and run the application, do the following:

```bash
# Clone the repository
git clone https://github.com/yarl/pattypan.git
cd pattypan
ant
```

This will run the default `build` target. It assumes that the current directory contains the OpenJFX SDK ZIP(s) and will unpack the required files to the correct locations. The resulting JAR will support Linux, Windows or both. The ZIPs present dictates what platforms will be supported. Note that the ZIPs should have their default name to be included.

A temporary directory will be used during the build process and removed afterwards. It's default path is *tmp/* and can be set using `ant -Dtmp=...`
# Build the project (compiles code and creates JAR in target/)
mvn clean package

You can also set test server or any other server:
# Run the application directly using Maven (recommended for development)
mvn javafx:run

# Alternatively, run the created JAR file (requires Java 11+)
# Note: Ensure your JAVA_HOME points to a JDK with JavaFX modules included, or handle JavaFX modules separately.
# java -jar target/pattypan-1.0.0.jar
```
java -jar pattypan.jar wiki="test.wikipedia.org"
java -jar pattypan.jar wiki="test2.wikipedia.org" protocol="https://" scriptPath="/w"

Maven automatically downloads all required dependencies, including OpenJFX. No manual downloads are needed.

You can also run the application with specific Wikimedia sites:

```bash
# Using mvn javafx:run (pass arguments after --)
mvn javafx:run -- -wiki=test.wikipedia.org
mvn javafx:run -- -wiki=test2.wikipedia.org -protocol=https:// -scriptPath=/w

# Using the JAR file
# java -jar target/pattypan-1.0.0.jar wiki="test.wikipedia.org"
# java -jar target/pattypan-1.0.0.jar wiki="test2.wikipedia.org" protocol="https://" scriptPath="/w"
```

Please note, that on test server file upload may be disabled for regular users. Admin account is suggested, you can request rights [here](https://test.wikipedia.org/wiki/Wikipedia:Requests/Permissions). If you have problems with program running, check [article on project wiki](https://github.com/yarl/pattypan/wiki/Run).

### License
Copyright (c) 2016 Paweł Marynowski.

Source code is available under the [MIT License](https://github.com/yarl/pattypan/blob/master/LICENSE). See the LICENSE file for more info. Program is using external libraries listed [here](https://github.com/yarl/pattypan/tree/master/lib).
Source code is available under the [MIT License](https://github.com/yarl/pattypan/blob/master/LICENSE). See the LICENSE file for more info. Program dependencies are managed via Maven and listed in the `pom.xml` file.

#### Credits
Name by Wojciech Pędzich. Logo by [Rickterto](//commons.wikimedia.org/wiki/User:Rickterto), licensed under the Creative Commons [BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en) license.
Expand Down
154 changes: 0 additions & 154 deletions build.xml

This file was deleted.

Binary file removed lib/BrowserLauncher2-1_3.jar
Binary file not shown.
Binary file removed lib/freemarker.jar
Binary file not shown.
Binary file removed lib/gson-2.9.0.jar
Binary file not shown.
Binary file removed lib/jxl.jar
Binary file not shown.
Binary file removed lib/metadata-extractor-2.11.0.jar
Binary file not shown.
Binary file removed lib/xmpcore-5.1.3.jar
Binary file not shown.
Loading