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

Need document for toot curses #50

Closed
kakakaya opened this issue Mar 5, 2018 · 3 comments
Closed

Need document for toot curses #50

kakakaya opened this issue Mar 5, 2018 · 3 comments

Comments

@kakakaya
Copy link
Contributor

kakakaya commented Mar 5, 2018

I couldn't find document about curses in toot curses -h or README, but found it in source code.

toot/toot/ui/app.py

Lines 344 to 371 in c6b1d91

def loop(self):
while True:
key = self.left.pad.getkey()
if key.lower() == 'q':
return
elif key.lower() == 'h':
self.help_modal.loop()
self.full_redraw()
elif key.lower() == 'v':
status = self.get_selected_status()
if status:
webbrowser.open(status['url'])
elif key.lower() == 'j' or key == 'B':
self.select_next()
elif key.lower() == 'k' or key == 'A':
self.select_previous()
elif key.lower() == 's':
self.show_sensitive()
elif key == 'KEY_RESIZE':
self.setup_windows()
self.full_redraw()

I propose to make document about curses, for better user experience.

@scrow
Copy link

scrow commented Jun 30, 2018

Documentation is lacking for this entire project. It's usually not that difficult for me to download some source files from Github, compile, and run, but I feel like I'm flying totally blind here. All of the documentation is way too sparse. Plenty of stuff to tell me what this project is supposed to do, nothing to tell me how to actually use it.

@ihabunek
Copy link
Owner

@scrow True. I started setting up proper docs, but it still requires a lot of work. Since this is a pet project, I can only invest so much time writing docs.

Can you tell me what you're trying to do, and why it was hard to find out? Installation is documented, and the CLI commands are pretty well explained if you append --help.

Finally, contributions are welcome (tm).

@ihabunek
Copy link
Owner

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

3 participants