ReadMe Wish List

[frog-o]

README Cleanup & Feedback Request

A lot of the current README.md is unnecessary, and there are duplicated sections. I am working on cleaning this up in my fork.

What I Need Feedback On

I am curious about:

• What people like or don't like about my new layout.
• What people would like to see improved in the documentation.

Why This Matters

I believe this project hasn’t gained traction due to:

• Poor documentation layout
• Broken links
• Unclear structure

I once stepped away from this project but truly love the idea. My goal is to eliminate the need for a build tool once the project is built, though I’m unsure if this is possible. Ideally, you could release a binary of the WebAssembly (WASM) and use it directly from a CDN.

DO KNOW that I am not a developer but a tinker—I'm just trying to make things better.

[frog-o]

This is work in progress

[williamstein]

Huge +1!!

[williamstein]

Ideally, you could release a binary of the WebAssembly (WASM) and use it directly from a CDN.

I think that's feasible. It's kind of like what this is:

https://www.npmjs.com/package/python-wasm

I really wish I had the time/resources to work on cowasm more. I solved quite a few very hard (for me) low level problems building this, but I don't have more fuel in the tank right now for this. In any case, if/when you submit any PR's or have ideas, I'll do what I can to be supportive.

[frog-o]

Hay that was fast reply thanks ;I noticed you say

I really wish I had the time/resources to work on cowasm more. I solved quite a few very hard (for me) low level problems building this, but I don't have more fuel in the tank right now for this. In any case, if/when you submit any PR's or have ideas, I'll do what I can to be supportive.

Wow ,I have the same problem except mine is typically not a fuel problem. I am not going to hold you to that I don't think I going to make much for pull request.I have a problem of just not being able to get things done because my lack of

• knowledge
• good communication and
• free time. My free time is just the weekend if I am lucky,

Most of the stuff I write I send through copilot and/or perplexity.ai Just to make sure it is readable and polite. I am horrible at spelling and people often get hung up on that instead of what I want to say. So the biggest help I need is when you see me get too far off tack is to let me know. I don't want to spend hours working on something you don't like and really want to work on what you would like to see.

Your main documentation done a great job pointing to https://www.npmjs.com/package/python-wasm and I am going to have to put it back in my fork but the link in that documention is broken. That Readme is the next thing I am going to have to address and I need to start working on. I need to fix the documentation to point to the spot you moved it to once I find it. I was hoping I could learn how to build just the wasm module. I do my programming on the raspberry pi with 8gb ram (which is a extremely small low power arm 64 bit processer with an SD card and a couple of USB) so I want to keep the compilation to a minimum for both space, time and speed. I was reading the main documentation and while I was moving it to it's own Readme noticed you say it is important to use the specific version of zig compiler. So that make things a little more complicated I can't use pre-compiled version of that it existed. I never used the zig compiler yet so that will be interesting.

[williamstein]

I don't want to spend hours working on something you don't like [...] our main documentation done a great job pointing to https://www.npmjs.com/package/python-wasm and I am going to have to put it back in my fork but the link in that documention is broken.

My one recommendation would be to start with some small PR's, e.g., fixing some links. That way you can see that I quickly merge them (or not) depending on what they do.

Regarding zig, unfortunately I suspect due to how unstable zig is, that it will be quite challenging to update everything to work with the latest version of zig. If I were actively working on this project, that would be the first thing I would do though. But there are certainly other ways to add value, which could actually have a lot more impact (e.g., fixing a broken link, improving the docs/README).