Skip to content

Commit eb0f66e

Browse files
committed
fix: Correct installation formatting and typos
1 parent e193f21 commit eb0f66e

1 file changed

Lines changed: 19 additions & 18 deletions

File tree

README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# FastImage — SIMD‑Accelerated, Off‑Heap Image Processing for Java
1+
# FastImage — SIMD‑Accelerated, Off‑Heap Image Processing for Java
22

33
**Ultra-fast native image processing using AVX2/SSE4.1 kernels and zero-GC memory management.**
44

@@ -8,10 +8,10 @@
88
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
99
[![JitPack](https://jitpack.io/v/andrestubbe/FastImage.svg)](https://jitpack.io/#andrestubbe/FastImage)
1010

11-
FastImage ist eine ultra‑schnelle, native‑beschleunigte Image‑Processing‑Engine für Java, gebaut für das FastJava‑Ecosystem. Es kombiniert AVX/SSE SIMD, off‑heap Storage, zero‑copy Pipelines und eine fluent API, um typische BufferedImage‑Operationen **10–50× schneller** auszuführen — ohne GC‑Pressure, ohne Pixel‑Loops, ohne JVM‑Overhead.
11+
FastImage ist eine ultra‑schnelle, native‑beschleunigte Image‑Processing‑Engine für Java, gebaut für das FastJava‑Ecosystem. Es kombiniert AVX/SSE SIMD, off‑heap Storage, zero‑copy Pipelines und eine fluent API, um typische BufferedImage‑Operationen **10–50× schneller** auszuführen — ohne GC‑Pressure, ohne Pixel‑Loops, ohne JVM‑Overhead.
1212

1313
```java
14-
// Quick Start SIMD-Accelerated Filtering
14+
// Quick Start — SIMD-Accelerated Filtering
1515
import fastimage.FastImage;
1616

1717
public class Demo {
@@ -45,11 +45,11 @@ public class Demo {
4545

4646
## Key Features
4747

48-
- **🚀 SIMD Acceleration** Hand-optimized C++ kernels using **AVX2** and **SSE4.1** vector instructions.
49-
- **🧠 Zero-GC Overhead** Pixels are stored in **off-heap** memory, preventing GC pauses during heavy manipulation.
50-
- **🌀 Advanced Blur Suite** Real-time Gaussian, Stack (iOS-style), and Kawase blurs.
51-
- **🛡️ Fail-Safe JNI** Robust error handling with `FastImageException` and native handle validation.
52-
- **🔄 Fast Conversion** Optimized bit-copying between `BufferedImage` and native memory.
48+
- **🚀 SIMD Acceleration** — Hand-optimized C++ kernels using **AVX2** and **SSE4.1** vector instructions.
49+
- **🧠 Zero-GC Overhead** — Pixels are stored in **off-heap** memory, preventing GC pauses during heavy manipulation.
50+
- **🌀 Advanced Blur Suite** — Real-time Gaussian, Stack (iOS-style), and Kawase blurs.
51+
- **🛡️ Fail-Safe JNI** — Robust error handling with `FastImageException` and native handle validation.
52+
- **🔄 Fast Conversion** — Optimized bit-copying between `BufferedImage` and native memory.
5353

5454
---
5555

@@ -72,7 +72,7 @@ FastImage utilizes the full power of your CPU, outperforming standard Java2D loo
7272
### Option 1: Maven (Recommended)
7373
Add the JitPack repository and the dependencies to your `pom.xml`:
7474

75-
`xml
75+
```xml
7676
<repositories>
7777
<repository>
7878
<id>jitpack.io</id>
@@ -87,26 +87,27 @@ Add the JitPack repository and the dependencies to your `pom.xml`:
8787
<artifactId>fastimage</artifactId>
8888
<version>v0.1.0</version>
8989
</dependency>
90+
9091
<!-- FastCore (Required Native Loader) -->
9192
<dependency>
9293
<groupId>com.github.andrestubbe</groupId>
9394
<artifactId>fastcore</artifactId>
9495
<version>v0.1.0</version>
9596
</dependency>
9697
</dependencies>
97-
`
98+
```
9899

99100
### Option 2: Gradle (via JitPack)
100-
`groovy
101+
```groovy
101102
repositories {
102103
maven { url 'https://jitpack.io' }
103104
}
104105
105106
dependencies {
106-
implementation 'com.github.andrestubbe:.1.0'
107+
implementation 'com.github.andrestubbe:fastimage:v0.1.0'
107108
implementation 'com.github.andrestubbe:fastcore:v0.1.0'
108109
}
109-
`
110+
```
110111

111112
### Option 3: Direct Download (No Build Tool)
112113
Download the latest JARs directly to add them to your classpath:
@@ -156,17 +157,17 @@ For detailed instructions on compiling the C++ JNI code and building the Maven F
156157
---
157158

158159
## License
159-
MIT License See [LICENSE](LICENSE) file for details.
160+
MIT License — See [LICENSE](LICENSE) file for details.
160161

161162
---
162163

163164
## Related Projects
164-
- [FastCore](https://github.com/andrestubbe/FastCore) Native Library Loader
165-
- [FastTheme](https://github.com/andrestubbe/FastTheme) Native Window Styling
166-
- [FastGraphics](https://github.com/andrestubbe/FastGraphics) Hardware-accelerated 2D Rendering
165+
- [FastCore](https://github.com/andrestubbe/FastCore) — Native Library Loader
166+
- [FastTheme](https://github.com/andrestubbe/FastTheme) — Native Window Styling
167+
- [FastGraphics](https://github.com/andrestubbe/FastGraphics) — Hardware-accelerated 2D Rendering
167168

168169
---
169-
**Made with by Andre Stubbe**
170+
**Made with âš¡ by Andre Stubbe**
170171

171172
<!--
172173
SEO Keywords: java, jni, simd, avx2, sse4, image processing, blur, gaussian, fastjava, off-heap

0 commit comments

Comments
 (0)