The ReadMe isn't good readable.

[Naoghuman]

The ReadMe isn't good readable.

• Momentary the ReadMe is a endless list of all samples.
• I find it's difficult to read and look if I want read about a special sample (e.g. NetBeans/Modular/Java).

Suggestion for the new structure:

1. Section Description.
2. Section Content contains a list from quick links (pointed to 3.) to all examples.
3. Section with all samples (e.g. tables for the 3 types of samples (java, maven, gradle)).
4. Section License.
5. Section Contribution.

[Naoghuman]

The samples here are only for the GitHub project openjfx-docs?

• So the main-title in the ReadMe can be rewritten to OpenJFX Docs Samples?

[Naoghuman]

Sample of a rewriten section.

• Should the first column renamed to Tool?
• Column HelloFX changed? Header = Sample, in rows = HelloFX

HelloFX

Contains samples of a simple HelloFX class that can be run from command line, with or without build tools.

CLI / Maven / Gradle sampels

First example of sample table

Build	HelloFX	Description
CLI	Sample	Simple HelloFX class to run on command line, without build tools.
Maven	Sample	Simple HelloFX class to run with Maven.
Gradle	Sample	Simple HelloFX class to run with Gradle.

Second example of sample table

Tool	Sample	Description
CLI	HelloFX	Simple HelloFX class to run on command line, without build tools.
Maven	HelloFX	Simple HelloFX class to run with Maven.
Gradle	HelloFX	Simple HelloFX class to run with Gradle.

[Naoghuman]

Sample of section Content

Content

• HelloFX
  • CLI / Maven / Gradle sampels
• CommandLine
  • Non-Modular: CLI / Maven / Gradle sampels
  • Modular: CLI / Maven / Gradle sampels

[Naoghuman]

A rewritten version of the ReadMe can be seen here:

• https://github.com/Naoghuman/samples
• Not final - see questions above.

[jperedadnr]

Looks good.

• Title can be changed, indeed, to OpenJFX Docs Samples or maybe to HelloWorld Samples with JavaFX 11?
• Your Readme looks fine, as long as you rename sampels to samples ;)
• About tools/build, I'll prefer Build Tools
• About HelloFX header and Sample link, I'd prefer Sample as header, and then HelloFX sample or HelloFX project for each row.
• For each section, before the table, don't add CLI / Maven / Gradle sampels to the title, just Non-modular samples, or Modular samples.
• Using IDEs, if you don't use Maven/Gradle, it doesn't mean you go to CLI to run, so we used the word Java, meaning that the IDE manages (with Ant tasks most of the times) to call the java commands. CLI will be misleading.

[Naoghuman]

• For the title I would prefer the first suggestion OpenJFX Docs Samples because it's more general. When a new not HelloWorld example will added, then the title must not refactored.
• Fix typo sampels to samples.
• First column should be Build Tools.
• Second column header is now Sample.
• Second row is now HelloFX sample / HelloFX project. The column is spelled Sample, so we should called the entry from my point of view HelloFX project.
• Remove CLI / Maven / Gradles samples in Content and sections. Rename them to Non-modular samples and Modular samples.
• Replase first column entry CLI with Java.
• Should the first section header Description removed? We have the main header from the document, starting then with some basic informations about...
• In the last section we wrote "Please go through list of issues to make...". Should before list not a 'the'?

Update version can be found unter: https://github.com/Naoghuman/samples

[jperedadnr]

Ok, it is getting better.

• Title: OpenJFX Docs Samples
• I'd also change the description then, from:

This repository contains a collection of JavaFX 11 samples that can be run with different options and build tools.
to:
This repository contains a collection of HelloFX samples. Each one is a very simple HelloWorld sample created with JavaFX 11 that can be run with different options and build tools.

• Makes sense, Sample header, HelloFX project.
• I'll keep the description
  -Of course, add the list

[Naoghuman]

• Title: OpenJFX Docs Samples
• Update description to: "This repository contains a collection of HelloFX samples. Each one is a very simple HelloWorld sample created with JavaFX 11 that can be run with different options and build tools."
• Second column in the tables will have header=='Sample', in row=='HelloFX project'.
• Title 'Description' will keep.
• Fix type missing 'the' in section 'Contribution'.
• Add in last section 'Contribution' a hyperlink for 'pull requests' to https://help.github.com/articles/about-pull-requests/

Update version can be found unter: https://github.com/Naoghuman/samples
For me the ReadMe looks good, so when you have nothing more then I will do a PR.

[jperedadnr]

Yes, looks fine now, go ahead with the PR, thank you.