Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme cleanup #741

Merged
merged 2 commits into from
Feb 21, 2016
Merged

Readme cleanup #741

merged 2 commits into from
Feb 21, 2016

Conversation

muuki88
Copy link
Contributor

@muuki88 muuki88 commented Feb 18, 2016

The current readme bothered me for quite some time as information is stale, no easy starting point and not enough pointers to our documentation. I tried to improve this.

@kardapoltsev @fiadliel WDYT?

@muuki88 muuki88 added the documentation Documentation should be extended or updated label Feb 18, 2016
* Java application with startscripts for linux/osx/windows
* Java server additional autostart configurations
* [Java application] with startscripts for linux/osx/windows
* [Java server application][] with additional autostart configurations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how this link format is supposed to work, but it seems to go to the same link as "Java application" above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are two ways of defining links in markdown the [Description][Link Name] is used by default at Stackoverflow.
The inline variant [Description](link) clutters the text if not standalone.

@fiadliel
Copy link
Contributor

Some small comments, but looks great!

muuki88 added a commit that referenced this pull request Feb 21, 2016
@muuki88 muuki88 merged commit 12c1549 into master Feb 21, 2016
@muuki88 muuki88 deleted the wip/new-readme branch February 21, 2016 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation should be extended or updated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants