search

haskell / vector

An efficient implementation of Int-indexed arrays (both mutable and immutable), with a powerful loop optimisation framework .
Other
360 stars 141 forks source link

High level documentation? #443

Open asarkar opened 2 years ago

asarkar commented 2 years ago

README refers to hackage, hackage refers to itself, eventually, there's no usage instructions or tutorials for one to get started.

Shimuuar commented 8 months ago

Vector does lack high level documentation. And unless someone steps up and write it it's going to stay this way. So I mark this issue as help-wanted

AlexMaryW commented 2 months ago

Hi, I'd like to help out here :) just one question: what would you like the README to cover? I was thinking of some introduction, code examples/usage instructions, differentiation between vector and array.

Please note that this tutorial on Haskell Wiki is currently linked on Hackage, but maybe we could also consider linking this one? I think it's less overwhelming and more concise. It might be a bit pointless to write another tutorial just for the sake of it if there are some good and easy-to-follow tutorials already out there.