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.

Sign up for GitHub

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

Jump to bottom

Update README with different build instructions #5593

Merged
merged 1 commit into from
Apr 26, 2024
Merged

Update README with different build instructions #5593

merged 1 commit into from
Apr 26, 2024

Conversation

contificate
Copy link
Contributor

  • Removes large package listing from build instructions.
  • Adds explanation about tags when working from a clone of a fork of the repo.
  • Includes miscellaneous changes to wording.

@contificate
Update README with different build instructions
99137b6 
- Removes large package listing from build instructions.
- Adds explanation about tags when working from a clone of a fork of the repo.
- Includes miscellaneous changes to wording.

Signed-off-by: Colin <colin.barr@cloud.com>
@contificate
Copy link
Contributor Author

Marking this ready for review.

This is just the way that I've been successfully shown to build the toolstack.
There is a small issue with message-switch/core/dune being unable to find xapi-stdext-threads, but it has seemingly not caused major issue on my end.

Please let me know if you think the previous instructions should be retained, if this change is too reductive, or if you go about building the toolstack in a different way.

@contificate contificate marked this pull request as ready for review April 25, 2024 12:55
@lindig lindig self-requested a review April 25, 2024 13:10
@lindig
Copy link
Contributor

lindig commented Apr 25, 2024

Good to see the many typos corrected, too. Does the README still include instructions to only use the
xs-opam as an opam remote and to remove the default one?

@contificate
Copy link
Contributor Author

Good to see the many typos corrected, too. Does the README still include instructions to only use the xs-opam as an opam remote and to remove the default one?

Yes, perhaps easier to see the rendered markdown on my fork than to read the diff.

Vincent-lau
Vincent-lau approved these changes Apr 25, 2024
View reviewed changes
Copy link
Contributor

@Vincent-lau Vincent-lau left a comment

Choose a reason for hiding this comment

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

👍

README.markdown Show resolved Hide resolved
README.markdown
@@ -78,6 +73,29 @@ To build xen-api from source, we recommend using [opam](https://opam.ocaml.org/d

The binaries should now be in `./_build/install/default/bin`!

Working From a Fork
Copy link
Contributor

@Vincent-lau Vincent-lau Apr 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Shall we move this section under the Contributions section below?

Actually I think leaving it here is fine as well, up to you

@robhoes robhoes merged commit 4db52ad into xapi-project:master Apr 26, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lindig lindig lindig approved these changes

@psafont psafont psafont left review comments

@robhoes robhoes robhoes approved these changes

@Vincent-lau Vincent-lau Vincent-lau approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@contificate @lindig @robhoes @psafont @Vincent-lau