Readme suggestions - Githubissues

stillwwater / command_terminal

Unity Command Terminal: In-Game Console

MIT License

445 stars 60 forks source link

Readme suggestions #6

Open nothke opened 6 years ago

nothke commented 6 years ago

Not really an issue but a suggestion for readme. 2 things you should mention to make it work:

You need to add using CommandTerminal; to be able to register commands
and you need to have CommandArg[] args as a parameter even if you don't have any parameters. This confused me as it wasn't showing up in commands and there were no errors.

And great stuff! Thanks a lot!

stillwwater commented 5 years ago

I realize the readme is quite minimal so I'll be sure to add a note about the using derivative.

The CommandArg[] parameter is shown in the examples, do you think a footnote about requiring it even in commands without parameters would be useful there?

Thanks for the suggestion!

ailrk commented 5 years ago

How do you use a library without importing?