Bug 512926 - Add README files for nice display on Github mirrors
Summary: Add README files for nice display on Github mirrors
Status: ASSIGNED
Alias: None
Product: Lyo
Classification: Technology
Component: ReleaseEngineering (show other bugs)
Version: 2.1.0   Edit
Hardware: PC Mac OS X
: P3 normal (vote)
Target Milestone: 2.x.x   Edit
Assignee: Andrii Berezovskyi CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-03-01 16:13 EST by Andrii Berezovskyi CLA
Modified: 2017-11-06 12:52 EST (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Andrii Berezovskyi CLA 2017-03-01 16:13:16 EST
Our repositories are mirrored on Github (e.g. https://github.com/eclipse/lyo.client). The convention is to use README.md file to create a welcoming landing page for the repository.

We should include:

* project description
* build page link
* getting started information
* link for filing bugs and contributing
Comment 1 Andrii Berezovskyi CLA 2017-03-01 16:13:43 EST
I also want to use this bug to test the Hudson build config.
Comment 2 Eclipse Genie CLA 2017-03-01 16:16:04 EST
New Gerrit change created: https://git.eclipse.org/r/92126
Comment 4 Andrii Berezovskyi CLA 2017-03-01 18:18:31 EST
Merged README for lyo.client.

Outstanding READMEs:

* docs
* server
* ¿testsuite
* ¿rio
* dependencies (bug 512934)
Comment 5 Andrii Berezovskyi CLA 2017-03-03 12:39:45 EST
Hudson link broken: https://github.com/eclipse/lyo.client/blob/master/README.md
Comment 6 Andrii Berezovskyi CLA 2017-03-10 09:58:41 EST
See https://github.com/ld4mbse/oslc4j