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

Document supported hardware architectures #258

Open
zamazan4ik opened this issue Jun 19, 2022 · 2 comments
Open

Document supported hardware architectures #258

zamazan4ik opened this issue Jun 19, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@zamazan4ik
Copy link

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
Copy link
Member

ecton commented Jun 19, 2022

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.

@ecton ecton added the documentation Improvements or additions to documentation label Jun 19, 2022
@zamazan4ik
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants