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

README.md: add overview, build instructions #13

Merged
merged 5 commits into from
Nov 2, 2018

Conversation

spl
Copy link
Contributor

@spl spl commented Oct 30, 2018

Here's an attempt at updating the README.md to include:

I'm sure it's not all correct, so your feedback is welcome.

This was referenced Oct 30, 2018
@devosb
Copy link
Contributor

devosb commented Nov 2, 2018

The content looks excellent. I will move some of the material that is duplicated from the README file (which needs to be kept in some form, see #14 (comment) for details). Maybe I will rename this file to BUILD.md (like HarfBuzz does) and then the README file can be renamed to something like INSTALL, after the contents of INSTALL is merged into the new BUILD.md file.

@devosb
Copy link
Contributor

devosb commented Nov 2, 2018

The build instructions would be moved to a BUILD.md file, the overview would remain in README.md.

@devosb devosb merged commit ade0648 into silnrsi:master Nov 2, 2018
@spl spl deleted the build-instructions branch November 7, 2018 12:45
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.

3 participants