Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DevCharly committed Mar 18, 2023
1 parent c077751 commit a5ab64d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 24 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Markdown Writer FX Change Log
=============================

## Unreleased
## 1.0

- Spell and grammar checking with LanguageTool. (issue #10)
- Project Manager:
Expand Down
39 changes: 16 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand Down

0 comments on commit a5ab64d

Please sign in to comment.