Consolidate DESCRIPTION.rst and README.md #300

Activity

1. leofang

   added this to the cuda.core beta 3 milestone on Dec 13, 2024
2. leofang

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   P1Medium priority - Should doMedium priority - Should do

   cuda.coreEverything related to the cuda.core moduleEverything related to the cuda.core module

   on Dec 13, 2024
3. vzhurba01 commented on Jan 15, 2025

   

   vzhurba01

   on Jan 15, 2025

   Contributor

   More actions

   I'd like to extend the scope of this issue to help consolidate/organize all the README.md and DESCRIPTION.rst between cuda-python, cuda.bindings and cuda.core. When resolving issue #297 with PR 397 I found that cuda.bindings also has awkwardness in creating a consolidated file that is presentable on both PyPI and GitHub.

   For PyPI, it seems like we'd want:

   • To direct users to documentation
   • Runtime dependencies
   • Installing? (Perhaps a link to installing page in documentation is better)

   For GitHub:

   • Same as PyPI
   • Development info
   • Running tests, samples and benchmarks

   There's some overlap in dev info across subpackages that may belong better under cuda-python:

   • Code Linting
   • Code Signing
   • Supported Python Versions

   In conclusion, info that applies to all subpackages should be under cuda-python while development info specific to a subpackage should be kept out of PyPI.

   ❤️React with ❤️1Reacted by Leo Fang
4. vzhurba01

   added

   cuda.bindingsEverything related to the cuda.bindings moduleEverything related to the cuda.bindings module

   on Jan 15, 2025
5. leofang commented on Jan 15, 2025

   

   leofang

   on Jan 15, 2025

   MemberAuthor

   More actions

   Sounds like a plan! You have earned the title "trusted assignee," Vlad 👍

   😄React with 😄1Reacted by Vladislav Zhurba
6. leofang

   assigned

   vzhurba01

   on Jan 15, 2025
7. leofang commented on Jan 15, 2025

   

   leofang

   on Jan 15, 2025

   MemberAuthor

   More actions

   cc @rwgk for vis

   👍React with 👍1Reacted by Ralf W. Grosse-Kunstleve
8. leofang

   added

   P2Low priority - Nice to haveLow priority - Nice to have

   and removed

   P1Medium priority - Should doMedium priority - Should do

   on Feb 18, 2025
9. kkraus14

   modified the milestones: cuda.core beta 3, cuda.core beta 4 on Feb 18, 2025
10. kkraus14

    added

    P1Medium priority - Should doMedium priority - Should do

    and removed

    P2Low priority - Nice to haveLow priority - Nice to have

    on Feb 18, 2025
11. kkraus14

    closed this as completedin #590on Apr 29, 2025