octoleo/plantuml
1
0
Fork 0
mirror of https://github.com/octoleo/plantuml.git synced 2024-12-22 10:59:01 +00:00
Code Issues Releases Wiki Activity

Update BUILDING.md

Browse Source
This commit is contained in:
PlantUML 2023-10-05 09:46:08 +02:00 committed by GitHub
parent 9a05b92b26
commit 76ca2de8e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
BUILDING.md
View File

@ -1,16 +1,16 @@
# Building PlantUML
# 🚧 Building PlantUML
Thank you for your interest in contributing to PlantUML! This guide will help you build the PlantUML project.
PlantUML can be built using either [Gradle](#building-plantuml-with-gradle) or [Ant](#building-plantuml-with-ant-alternative-method). It's recommended to use Gradle as the primary build tool for this project. You will find instructions for both methods, starting with Gradle.
## Java Compatibility and Development Notes
## ☕ Java Compatibility and Development Notes
🌱 **PlantUML & Java 8 Compatibility**
### PlantUML & Java 8 Compatibility
We understand the ubiquity and prevalence of Java 8 in numerous environments and infrastructures. Thus, **PlantUML remains steadfastly compatible with Java 8**. Despite the version’s age and the availability of newer releases, we recognize that a substantial number of users and enterprises still depend on Java 8. Therefore, you can confidently run PlantUML in environments where Java 8 is installed, ensuring accessibility and functionality for a wide array of users.
🔍 **Unitary Tests & Advanced Java Versions**
### Unitary Tests & Advanced Java Versions
While PlantUML maintains its compatibility with Java 8, our development and testing environments leverage the capabilities of more recent Java versions. All unitary tests are conducted using a newer Java version, not only to utilize advanced features and optimizations but also to ensure the robustness of PlantUML in more updated systems.
@ -19,11 +19,11 @@ This means:
- **For Contributors/Developers**: If you wish to run unitary tests, a more recent version of Java will be required. This ensures that tests run efficiently and utilize the latest features/optimizations, but it in no way impedes the usage of PlantUML with older Java versions.
🔄 **Your Contribution Matters**
### Your Contribution Matters
Whether you're using an old or a new version of Java, your feedback, contributions, and insights are valuable in enhancing PlantUML. We strive to maintain a balance between adopting new technology and ensuring accessibility for all users, and your experiences aid us in striking this balance effectively.
## Building PlantUML with Gradle
## 🎓 Building PlantUML with Gradle
### Prerequisites
@ -91,7 +91,7 @@ If you encounter any issues while building the project, feel free to ask for hel
Thank you for contributing to PlantUML!
## Building PlantUML with Ant (Alternative Method)
## 🐜 Building PlantUML with Ant (Alternative Method)
For those who prefer using Ant, or only have access to Ant, we provide a `build.xml` Ant build script as a fallback option to build PlantUML.
@ -128,7 +128,7 @@ ant
If you have Ant set up correctly and the prerequisites are met, the build process should start, and the project will be built based on the instructions in the `build.xml`.
## About the `graphviz.dat` file
## 📦 About the `graphviz.dat` file
Within certain PlantUML releases, we've incorporated an embedded, compiled version of GraphViz specifically tailored for Windows. This initiative was taken to streamline the user experience for our Windows users, eliminating the need for them to undertake separate installations or configurations.