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

Update documentation "How-to-build", now that we are using alpaka #309

Open
1 of 13 tasks
ichinii opened this issue Jul 30, 2024 · 1 comment
Open
1 of 13 tasks

Update documentation "How-to-build", now that we are using alpaka #309

ichinii opened this issue Jul 30, 2024 · 1 comment
Assignees
Labels
A-docs Area: Project documentation C-enhancement Category: Adding a new feature

Comments

@ichinii
Copy link
Collaborator

ichinii commented Jul 30, 2024

Update documentation "How-to-build"
https://hz-b.github.io/rayx/Introduction/05-How-to-build.html#cloning-the-repository

now that we switched to alpaka. The How-to-build section in our documentation is outdated.

  • List CMake configure options
  • Test and update prerequisites for Ubuntu
  • Test and update build steps for Ubuntu
  • Let someone else confirm that the described steps work on Ubuntu
  • Test and update prerequisites for Windows
  • Test and update build steps for Windows
  • Let someone else confirm that the described steps work on Windows
  • Test and update prerequisites for Arch/Manjaro
  • Test and update build steps for Arch/Manjaro
  • Let someone else confirm that the described steps work on Arch/Manjaro
  • Probably remove Fedora from the list
  • Explain compiler and cuda compatibility
  • Document compile.sh script
@ichinii ichinii added C-enhancement Category: Adding a new feature question Further information is requested labels Jul 30, 2024
@ichinii ichinii added A-docs Area: Project documentation and removed C-enhancement Category: Adding a new feature question Further information is requested labels Jul 30, 2024
@ichinii ichinii assigned ichinii and unassigned Atraxus Jul 30, 2024
@Atraxus Atraxus added C-enhancement Category: Adding a new feature I-high labels Jul 31, 2024
@Atraxus
Copy link
Collaborator

Atraxus commented Jul 31, 2024

It might be difficult to get information on the build dependencies from developers who already have a working set-up. I will try to figure out what packages I installed on my Arch system for RAYX but I am not sure I will find exactly the needed ones.

I think the compile.sh script is not relevant to most developers. And those who want to use it will understand it.

@Atraxus Atraxus removed the I-high label Sep 18, 2024
@Atraxus Atraxus moved this to Ready in RAYX: v1.0.0 Sep 18, 2024
@ichinii ichinii moved this from Ready to In review in RAYX: v1.0.0 Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Project documentation C-enhancement Category: Adding a new feature
Projects
None yet
Development

No branches or pull requests

2 participants