From 5254f93f376425f88a39075b4b046f0819bac3ba Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ole=20P=C3=B6schl?=
<62295828+olepoeschl@users.noreply.github.com>
Date: Sat, 29 Apr 2023 14:19:18 +0200
Subject: [PATCH] Update README.md
---
README.md | 12 +++---------
1 file changed, 3 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 79944f08..6d84a2e0 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,10 @@
-# NQueensFAF library
-A Java library for easily implementing custom solvers (algorithms) for the N Queens problem. Contains a super fast Solver for CPU using pure Java and for GPU using OpenCL. The built in Solvers allow you to save their state for continuing the execution at some time later.
-
Initially created for [NQueensFAF](https://github.com/olepoeschl/NQueensFAF). For more information about the built in Solvers, have a look at [NQueensFAF](https://github.com/olepoeschl/NQueensFAF).
+# NQueensFAF
+A Java framework containing an insanely fast Solver for CPU using pure Java and for GPU using OpenCL. Also provides useful utilities for implementing custom n queens problem solving algorithms.
+This proces uses Java 17.
### Download
See the "Releases" section.
-# Getting Started
-The library uses Java 17.
-
As stated below, this project depends on [LWJGL 3](http://www.lwjgl.org/), so make sure you include it in your project setup as well as its native jars.
-
# Documentation
Only the core package `de.nqueensfaf` is documented.
You can access the javadocs [here](https://olepoeschl.github.io/NQueensFAF-Library/).
@@ -25,7 +21,6 @@ To use for example the built in CpuSolver, do it like in the following code snip
CpuSolver cpuSolver = new CpuSolver();
cpuSolver.setN(16);
cpuSolver.setThreadcount(2);
-cpuSolver.setTimeUpdateDelay(50).setProgressUpdateDelay(50);
cpuSolver.setOnProgressUpdateCallback((progress, solutions) -> System.out.println("Progress: " + progress + " (" + solutions + " solutions)"));
cpuSolver.addTerminationCallback(() -> System.out.println("CPU finished after " + cpuSolver.getDuration() + " ms!"));
cpuSolver.solve();
@@ -36,7 +31,6 @@ To use for example the built in CpuSolver, do it like in the following code snip
GpuSolver gpuSolver = new GpuSolver();
gpuSolver.setN(19);
gpuSolver.setDevice(0);
-gpuSolver.setTimeUpdateDelay(69).setProgressUpdateDelay(420);
gpuSolver.setOnProgressUpdateCallback((progress, solutions) -> System.out.println("Progress: " + progress + " (" + solutions + " solutions)"));
gpuSolver.addTerminationCallback(() -> System.out.println("GPU finished after " + gpuSolver.getDuration() + " ms!"));
gpuSolver.solve();