README: overhaul file structure

[bmeneg]

In order to make the README information more clear this patch overhaul its structure and update its content to match the current state of the tool.

Signed-off-by: Bruno Meneguele bmeneg@redhat.com

Fix #777 . This PR semantically depends on PR #809 being merged, otherwise some recommendations won't work as expected.

[bmeneg]

@zaquestion once PR #809 and this one here are merged, could you update the project "About" text dropping the "Lab wraps Git and Hub" part? I don't have permission to do so.

[codecov[bot]]

Codecov Report

Merging #811 (3371ecd) into master (f8ed118) will increase coverage by 0.80%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #811      +/-   ##
==========================================
+ Coverage   55.43%   56.24%   +0.80%     
==========================================
  Files          77       77              
  Lines        5771     5752      -19     
==========================================
+ Hits         3199     3235      +36     
+ Misses       2277     2227      -50     
+ Partials      295      290       -5     

Impacted Files	Coverage Δ
cmd/clone.go	71.87% <0.00%> (-2.20%)	:arrow_down:
cmd/issue.go	68.18% <0.00%> (ø)
cmd/mr_checkout.go	81.96% <0.00%> (ø)
cmd/fork.go	63.15% <0.00%> (+5.26%)	:arrow_up:
cmd/root.go	63.52% <0.00%> (+5.73%)	:arrow_up:
cmd/mr_discussion.go	85.07% <0.00%> (+28.35%)	:arrow_up:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 54a8737...3371ecd. Read the comment docs.

[zaquestion]

Might be worth adding a table of contents while you're at it, Readme has gotta a lot longer since the early days

[bmeneg]

Oh, sure, I'll add the toc :)

[bmeneg]

@zaquestion I just realized that GitHub itself has a table of contents in the left of readme's filename:

It was released mid last year. With that I think we don't really need to have a specific toc in our doc.

[bmeneg]

Lol.. I'm pretty sure a README file change don't affect a build testing:

409 {message: {base: [PG::QueryCanceled: ERROR:  canceling statement due to statement timeout

And I'm almost sure it's not client's problem (error 40x) .. hahaha.

[zampierilucas]

@zaquestion I just realized that GitHub itself has a table of contents in the left of readme's filename:

It was released mid last year. With that I think we don't really need to have a specific toc in our doc.

Does GitLab support that? If not, It's not worth the work IMO, as we are moving soon™ to GitLab.

[bmeneg]

GitLab requires an explicit toc with [[_TOC_]]. Since it's different for github we can change it once we migrate to GitLab.

[zaquestion]

@zaquestion once PR https://github.com/zaquestion/lab/pull/809 and this one here are merged, could you update the project "About" text dropping the "Lab wraps Git and Hub" part? I don't have permission to do so.

Can do, feel free to email me if I forget / fail to notice this merge.

[bmeneg]

@zaquestion once PR #809 and this one here are merged, could you update the project "About" text dropping the "Lab wraps Git and Hub" part? I don't have permission to do so.

Can do, feel free to email me if I forget / fail to notice this merge.

:-) ack! Will do.

[bmeneg]

@zaquestion, just fyi.. you can now update project's description. I'm hitting the merge button right now.