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

(docs): Update README to be a bit nicer #100

Merged
merged 1 commit into from
Apr 3, 2020
Merged

Conversation

ClementTsang
Copy link
Owner

@ClementTsang ClementTsang commented Apr 3, 2020

Description

A description of the change and what it does. If relevant, please provide screenshots of what results from the change:

Updates documentation to be more recent.

Note: Delete old documentation files after release! They'll be irrelevant then.

Issue

If applicable, what issue does this address?

Closes: #40

Type of change

Remove the irrelevant ones:

  • Other (something else - please specify if relevant):

Mostly documentation updates

Test methodology

Please state how this was tested:

Please tick which platforms this change was tested on:

  • Windows
  • macOS
  • Linux

Checklist

Please ensure all are ticked (and actually done):

  • Change has been tested to work
  • Areas your change affects have been linted using rustfmt
  • Code has been self-reviewed
  • Code has been tested and no new breakage is introduced
  • Documentation has been added/updated if needed
  • No merge conflicts arise from the change

Other information

Provide any other relevant information:

@ClementTsang ClementTsang merged commit 2a5d071 into master Apr 3, 2020
@ClementTsang ClementTsang deleted the documentation_update branch April 3, 2020 05:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reword parts of the README/documentation before release
1 participant