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

Remake the README.md #9

Open
4 of 5 tasks
Reuh opened this issue Mar 20, 2016 · 1 comment
Open
4 of 5 tasks

Remake the README.md #9

Reuh opened this issue Mar 20, 2016 · 1 comment

Comments

@Reuh
Copy link
Member

Reuh commented Mar 20, 2016

The README is almost the same as it was when we started the project, but ctrµLua is in an usable state now, so we need to make it more friendly to newcomers.
I think we should add:

  • Add screenshots. Everybody loves screenshots.
  • Hello world example.
  • Getting started guide (how to install, the essentials modules, ctrµLua's organisation and how to read the docs).
  • Remove this lie: "Everything is in the Wiki.". And we should probably remove everything outdated in the wiki too.
  • Add an actual credits section.
@WhatNodyn
Copy link
Member

There's an actual credits section. On the teeny blog but filling it alone is kinda hard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants