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

Big documentation update #8410

Merged
merged 33 commits into from
Sep 5, 2024
Merged

Big documentation update #8410

merged 33 commits into from
Sep 5, 2024

Conversation

alexreinking
Copy link
Member

@alexreinking alexreinking commented Sep 5, 2024

This is a big documentation update. I have:

  • Rewritten large parts of the build instructions
    • Dead links have been updated.
    • Version numbers and ranges bumped.
    • Instructions simplified (scattered bits of wisdom consolidated)
    • LLVM build options set to match the pip wheels.
    • Note that WebAssembly is required now.
  • Moved the README_*.md files to doc/ and added links to them to the base README.md
  • Split the Hexagon documentation into its own doc/Hexagon.md.
  • Split README_cmake.md into three more specialized documents (and updated the documentation,
  • Updated the documentation in README_python.md ~> doc/Python.md.
  • Updated the CMake install rules to include this documentation

The best way to review this PR will be to actually read the documentation, which is navigable starting from here:

Additional files with substantial changes are here:

Copy link
Contributor

@steven-johnson steven-johnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, just a few things that need tweaking

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
doc/BuildingHalideWithCMake.md Outdated Show resolved Hide resolved
doc/BuildingHalideWithCMake.md Outdated Show resolved Hide resolved
doc/BuildingHalideWithCMake.md Outdated Show resolved Hide resolved
doc/Python.md Outdated Show resolved Hide resolved
@alexreinking
Copy link
Member Author

Looks great, just a few things that need tweaking

Well spotted issues, thanks!

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
doc/CodeStyleCMake.md Outdated Show resolved Hide resolved
@alexreinking alexreinking merged commit 3a34741 into main Sep 5, 2024
9 of 13 checks passed
@alexreinking alexreinking deleted the alexreinking/documentation branch September 6, 2024 15:59
mcourteaux pushed a commit to mcourteaux/Halide that referenced this pull request Sep 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants