Skip to content
This repository was archived by the owner on Jun 18, 2024. It is now read-only.

Update README.md: only provide short usage info#369

Merged
serious6 merged 1 commit intoOfficeDev:masterfrom
evpaassen:patch-1
Jul 9, 2015
Merged

Update README.md: only provide short usage info#369
serious6 merged 1 commit intoOfficeDev:masterfrom
evpaassen:patch-1

Conversation

@evpaassen
Copy link
Copy Markdown
Contributor

The entire Getting Started Guide should be on the wiki, or in a separate docs folder, I think. We should only provide the most relevant info in the README.

@azurecla
Copy link
Copy Markdown

azurecla commented Jul 8, 2015

Hi @evpaassen, I'm your friendly neighborhood Azure Pull Request Bot (You can call me AZPRBOT). Thanks for your contribution!
You've already signed the contribution license agreement. Thanks!
We will now validate the agreement and then real humans will evaluate your PR.

TTYL, AZPRBOT;

@evpaassen
Copy link
Copy Markdown
Contributor Author

Perhaps some of the removed content should still be migrated...

@evpaassen
Copy link
Copy Markdown
Contributor Author

Ref #154.

Comment thread readme.md
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

maybe exchange this with X.X-SNAPHOT to prevent future changes (same for groovy section).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

However, if we'd keep the version number here, this would be the easiest way to determine the current project version for new users.

Many other projects have it this way, for example:

The downside is indeed that with every release, the version number has to be updated in the README too.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I also can live with that until we have a nice gh-page 😉

@serious6
Copy link
Copy Markdown
Member

serious6 commented Jul 8, 2015

👍

@serious6
Copy link
Copy Markdown
Member

serious6 commented Jul 8, 2015

@evpaassen please add [ci skip] somewhere in the commit msg. We do not need to trigger a build for this change.

The entire Getting Started Guide should be on the wiki, or in a separate docs folder, I think. We should only provide the most relevant info in the README.

[ci skip]
@evpaassen
Copy link
Copy Markdown
Contributor Author

Done.

serious6 added a commit that referenced this pull request Jul 9, 2015
Update README.md: only provide short usage info 
[ci skip]
@serious6 serious6 merged commit 1717528 into OfficeDev:master Jul 9, 2015
@serious6
Copy link
Copy Markdown
Member

serious6 commented Jul 9, 2015

@evpaassen thanks for your contribution.

@serious6 serious6 added this to the 2.0 milestone Jul 9, 2015
@evpaassen evpaassen deleted the patch-1 branch July 9, 2015 11:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants