From a5ab64d173b44da57bde146d3f09e85402de67af Mon Sep 17 00:00:00 2001 From: Karl Tauber Date: Sat, 18 Mar 2023 17:44:02 +0100 Subject: [PATCH] updated README.md --- CHANGES.md | 2 +- README.md | 39 ++++++++++++++++----------------------- 2 files changed, 17 insertions(+), 24 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index c618abaa..7bfad5d0 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,7 +1,7 @@ Markdown Writer FX Change Log ============================= -## Unreleased +## 1.0 - Spell and grammar checking with LanguageTool. (issue #10) - Project Manager: diff --git a/README.md b/README.md index 7cb5ef3a..2a5d940e 100644 --- a/README.md +++ b/README.md @@ -17,46 +17,39 @@ Features * Keyboard shortcuts to insert Markdown (Bold, Italic, Code, Links, Images, Header, Lists, ...) * Auto-indent lists * Search and replace + * Spell and grammar checking with [LanguageTool](https://languagetool.org/) + for more than 30 languages and dialects. * Project manager * HTML preview * HTML source preview * Markdown AST view - * Multi-platform: Windows, Mac, Linux, ... + * Multi-platform: Windows, Mac and Linux -Requirements ------------- +Download +-------- -**Java 19 is required** to run current releases. +See "Assets" in +[releases section](https://github.com/JFormDesigner/markdown-writer-fx/releases). -Installation ------------- -Download -[markdown-writer-fx-0.12.zip](https://github.com/JFormDesigner/markdown-writer-fx/releases/download/0.12/markdown-writer-fx-0.12.zip) -and extract it to any folder. +Changes +------- -Run: - - for Windows, `bin/markdown-writer-fx.bat` to start *Markdown Writer FX* - - and for Unix systems `./bin/markdown-writer-fx.sh` to start *Markdown Writer FX* +See [Change Log](CHANGES.md) -from the project folder. Building -------- -Prerequisites are git and Java 19 in order to build *Markdown Writer FX* form sources. +[Gradle](https://gradle.org) can be used to build Markdown Writer FX from source +code. **Java 19** is required to run Gradle (and Markdown Writer FX). - - get the source, e.g. by cloning the official repo with: - `git clone https://github.com/JFormDesigner/markdown-writer-fx.git` - - run `./gradlew assembleDist` to create the distribution in the - `$project/build/distributions/` folder. +The Gradle task `assembleDist` builds a distribution for the current platform +(uses `jpackage`) and requires that Gradle is running on a JDK that includes +JavaFX. E.g. BellSoft Liberica JDK (package 'Full JDK') or Azul Zulu JDK +(package 'JDK FX'). -Changes -------- - -See [Change Log](CHANGES.md) - Credits -------