khonsulabs / bonsaidb

A developer-friendly document database that grows with you, written in Rust
https://bonsaidb.io/
Apache License 2.0
1.01k stars 37 forks source link

Document supported hardware architectures #258

Open zamazan4ik opened 2 years ago

zamazan4ik commented 2 years ago

Hi!

Could you please put the information about supported architectures to the documentation please? E.e. about supported architectures for different operating systems, some specific requirements to the supported instructions, if you have any (e.g. maybe AVX is required - I do not know).

This kind of information is important for the end-users.

Thanks in advance!

ecton commented 2 years ago

Thank you for the feedback. I agree that this is important, but I'm also not sure what to document at this time. As far as I'm aware, BonsaiDb will run wherever the standard library compiles to. There may be specific dependencies of certain server-related functionality that I'm just not aware have extra requirements, but I know people have had success compiling for a variety of architectures.

Are you aware of any platforms that the standard library supports that BonsaiDb currently fails to compile for or work on? I would love to either document the issues or fix them.

zamazan4ik commented 2 years ago

No, I am not aware about such platforms. Maybe you can at least write a note something like "The library should work on any where the standard library works". Also, maybe you have platforms, which are more battle-tested than others (probably Linux/x86-64 or anything else) - you can write about this too, since it can at least show that on these platforms a chance to find a bug should be lower.