Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 2.16 KB

README.md

File metadata and controls

41 lines (30 loc) · 2.16 KB
Raw

🦠 Particle Life App

A GUI for the Particle Life Framework.

Join the Discord server!

Screenshot of the App

How to build this app from source

If you just want to try out this application, simply download the executables from particle-life.com. However, if you want to contribute to this repository or just mess with the code, you need to build the application from source.

For this, you need to have Git and Java with version 16 or higher installed on your computer. Confirm your Java version with java -version.

Then, execute these lines in the terminal:

git clone https://github.com/tom-mohr/particle-life-app.git
cd particle-life-app
./gradlew run

You should now see many particles on your screen. If you encounter any problems, ask for help in the #tech-support channel on the Discord server.

How to make a release

  • Confirm that everything is working correctly and check in with others that the current state of the main branch is ready for release.
  • Run ./gradlew zipApp from the project root. This generates the zip file particle-life-app.zip in ./build/zipApp/. It includes the Windows executable (.exe) along with other files.
  • Go to the Releases section of this GitHub repo and click Draft a new release.
  • Click Choose a tag and type the new version name:
    • Prefix the version name with the letter v. Some good tag names might be v1.0.0 or v2.3.4.
    • The version name should comply with semantic versioning. Talk to others if you are unsure about what to choose here.
  • Click Create a new tag.
  • Set the release title to match the tag name.
  • Use the description to summarize the changes of all commits since the last release.
  • Add the generated particle-life-app.zip as an asset to the release.
  • Click Publish release.