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 the README #145

Merged
merged 3 commits into from
Dec 12, 2024
Merged

Update the README #145

merged 3 commits into from
Dec 12, 2024

Conversation

shym
Copy link
Contributor

@shym shym commented Dec 11, 2024

This PR brings a couple of updates to the README. In particular it lists the components as that part of the documentation is out-of-sync after #134 (sorry about that).

It is split in 2 commits, as the first commit contains modifications that are also relevant for the 4.14 branch.

README.md Show resolved Hide resolved
@hannesm
Copy link
Member

hannesm commented Dec 12, 2024

for the README.md on the main branch, can we as well describe that it targets OCaml 5 (with the 1.x releases) -- and we have the branch "4.14" for the OCaml 4.14 series (which is well be maintained, with 0.8.x releases)

@hannesm
Copy link
Member

hannesm commented Dec 12, 2024

I forgot to say: thanks for your PR :)

shym added 3 commits December 12, 2024 12:33
In particular, use `Solo5` vs `solo5` consistently
At the beginning of the `README`, point users that would be interested
in OCaml 4.14 compilers support to the separate `4.14` branch by
explaining which branches and which version numbers are for which
compilers
@shym
Copy link
Contributor Author

shym commented Dec 12, 2024

for the README.md on the main branch, can we as well describe that it targets OCaml 5 (with the 1.x releases) -- and we have the branch "4.14" for the OCaml 4.14 series (which is well be maintained, with 0.8.x releases)

Good idea. I propose that in the last commit. I think it makes more sense to add that information near the beginning of the README and so I wondered whether I should pull the small “Supported compilers” section there also.

@hannesm hannesm merged commit cb1496d into mirage:main Dec 12, 2024
2 checks passed
@shym shym deleted the readme branch December 12, 2024 16:33
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.

2 participants