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

add a readme #4

Open
eepykate opened this issue Jul 2, 2020 · 4 comments
Open

add a readme #4

eepykate opened this issue Jul 2, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@eepykate
Copy link

eepykate commented Jul 2, 2020

it should

  • tell you how to build
  • tell you how to set up a server
  • tell you how to connect to a server
  • tell you the basic controls (ex: delete for clear)
  • say the window needs to be of a specific size or it won't properly and the chat won't render (Limitations section)
@RustemB
Copy link
Contributor

RustemB commented Jul 2, 2020

WiP

@elkowar
Copy link
Owner

elkowar commented Jul 2, 2020

I'm currently reworking the Command line interface, so we should probably wait until that is at least semi-finalized

@eepykate
Copy link
Author

eepykate commented Jul 6, 2020

@elkowar Also I'd recommend adding something saying delete no work on st and the fix (either use another term, or make st use ^[[3~ for the delete escape seq instead of ^[[P)

@elkowar elkowar added the documentation Improvements or additions to documentation label Jul 6, 2020
@Swexti
Copy link
Contributor

Swexti commented Sep 5, 2020

i made a readme since no one did it. thank me later

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

No branches or pull requests

4 participants