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 - rewrite the README #29

Open
bobtfish opened this issue Sep 16, 2022 · 1 comment
Open

README - rewrite the README #29

bobtfish opened this issue Sep 16, 2022 · 1 comment
Assignees

Comments

@bobtfish
Copy link
Collaborator

Make it actually attractive and informative.

Tell people how to build the project, how to install it and use it (as well as how to run the tests). (This may need some additional scaffolding to be able to install the binary we produce etc).

Split the dev notes out into a separate file.

Generally make this into an open source project that looks like something that someone might be able to use, rather than a random lump of code.

@khvzak khvzak self-assigned this Sep 19, 2022
@khvzak
Copy link
Member

khvzak commented Sep 19, 2022

I plan to integrate this project into mlua to provide a high level unified API.

For now I'll remove most of the details in README as the current state is WIP and not ready for anybody use or announcements.

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

No branches or pull requests

2 participants