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

Move things from README.rst to UPDATE.md#4569

Merged
richvdh merged 7 commits intorelease-v0.99.0from
rav/split_out_readme
Feb 5, 2019
Merged

Move things from README.rst to UPDATE.md#4569
richvdh merged 7 commits intorelease-v0.99.0from
rav/split_out_readme

Conversation

@richvdh
Copy link
Member

@richvdh richvdh commented Feb 5, 2019

The readme was getting pretty unmanageable and hard to grok. This is an attempt to simplify things by moving installation instructions from the README to a separate file. I've tried to resist the temptation to fix too much stuff while I'm here - it mostly just copies-and-pastes from one doc to the other, and changes from rst to md syntax.

@richvdh richvdh requested a review from a team February 5, 2019 13:13
@codecov-io
Copy link

Codecov Report

Merging #4569 into release-v0.99.0 will decrease coverage by 0.51%.
The diff coverage is n/a.

@@                 Coverage Diff                 @@
##           release-v0.99.0    #4569      +/-   ##
===================================================
- Coverage            74.87%   74.35%   -0.52%     
===================================================
  Files                  338      338              
  Lines                34495    35227     +732     
  Branches              5619     5825     +206     
===================================================
+ Hits                 25829    26194     +365     
- Misses                7082     7415     +333     
- Partials              1584     1618      +34

@neilisfragile
Copy link
Contributor

Looks totally sane to me, we need to think about the Synapse README/docs more holistically - I've not spent much time thinking about how that should look, but everything here is an improvement.

@richvdh richvdh merged commit 4561f3b into release-v0.99.0 Feb 5, 2019
@richvdh richvdh deleted the rav/split_out_readme branch February 5, 2019 13:55
@aaronraimist
Copy link
Contributor

Looks like a good start towards #4246

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.

4 participants