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

Improve README #138

Open
gilch opened this issue Nov 28, 2021 · 2 comments
Open

Improve README #138

gilch opened this issue Nov 28, 2021 · 2 comments
Labels
docs Explanation

Comments

@gilch
Copy link
Owner

gilch commented Nov 28, 2021

Too vague to really be actionable, I know, but first impressions matter, and I feel like it could be better than it is.

GitHub markdown is pretty limiting. Most interactivity is not allowed. Animated GIFs are possible, and I'm considering adding some. It does grab one's attention, and can show things off without too much effort from the watcher. I could probably put the whole quickstart[whirlwind tour] in there with one GIF per section. But making them is a significant effort and the docs are still in flux. There's probably a way to automate this, but I might have to write most of that myself.

I could also possibly link them to a "static" page that loads a Lissp REPL via pyodide. It's kind of slow loading on the first try though. And it would be a nontrivial effort to get it working. I've considered using Brython in the docs, but it had bugs at the time. That would at least load faster, but probably also a nontrival effort.

Hissp keeps gradually accumulating stars, but so far, not many users are doing anything visible with it. I'm considering adding social media buttons to the top of the readme, but since I try not to use those myself, they might be hard for me to test.

@gilch
Copy link
Owner Author

gilch commented Feb 11, 2022

Hissp 0.3.0 installs in pyodide now that it has a wheel on PyPI. Haven't tried Brython lately.

@gilch
Copy link
Owner Author

gilch commented Aug 26, 2022

Some progress on this in #164.

@gilch gilch added the docs Explanation label May 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Explanation
Projects
None yet
Development

No branches or pull requests

1 participant