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

Add badges to README.md #36815

Merged
merged 3 commits into from
Dec 14, 2023
Merged

Conversation

kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Dec 4, 2023

for those who want to play with Sage instantly, and also as a preparation for #36245.

See this REAME.md.

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

@kwankyu kwankyu changed the title Add binder badge to README.md Add a Binder badge to README.md Dec 4, 2023
@mkoeppe
Copy link
Contributor

mkoeppe commented Dec 4, 2023

@kwankyu
Copy link
Collaborator Author

kwankyu commented Dec 4, 2023

This is the Binder badge

Binder

Are the other badges below comparable with the Binder badge in the sense of "click, wait, and run sage either on command line or in jupyter online"?

Gitpod Ready-to-Code

This starts to build sage from source.

Open in GitHub Codespaces

This opens up an online platform where you can build sage from source.

For the docker, you run the docker image on your own local computer. Actually Binder is just a way to run the docker image online.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Dec 4, 2023

binder is completely free of charge.

gitpod seems free for the basic use for gitpod account owners.

codespaces seems free for me perhaps since I am a member of sagemath. Is this free also for casual visitors to our repo?

@mkoeppe
Copy link
Contributor

mkoeppe commented Dec 4, 2023

I think Codespaces requires someone to pay for it. I haven't used it. @tobiasdiez may know more about it.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Dec 4, 2023

According to https://docs.github.com/en/get-started/learning-about-github/githubs-plans, codespaces is free of charge for public repositories with some limit in time and space.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Dec 4, 2023

The codespaces badge allows code editing but running Sage there requires building sage from source.

With more investigation, I see that the codespaces platform contains prebuilt sage, which is currently SageMath version 10.2.beta5, Release Date: 2023-09-27. This seems to be conda-based sage, defined by src/environment-dev.yml. I don't know why this is far behind the current version... (This seems the Sage built when I used the service last time.)

Anyway, as I said before, the codespaces is available right from the github interface. So we may omit this one.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Dec 4, 2023

I decided to add all three: binder, gitpod, codespaces. From README.md,

Screenshot 2023-12-04 at 9 21 30 PM

@kwankyu kwankyu changed the title Add a Binder badge to README.md Add badges to README.md Dec 4, 2023
@kwankyu
Copy link
Collaborator Author

kwankyu commented Dec 4, 2023

A link to the docker image is already in README:

https://github.com/sagemath/sage#sagemath-docker-images

Copy link

github-actions bot commented Dec 4, 2023

Documentation preview for this PR (built with commit 07a6fbc; changes) is ready! 🎉

Copy link
Contributor

@mkoeppe mkoeppe left a comment

Choose a reason for hiding this comment

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

LGTM

@kwankyu
Copy link
Collaborator Author

kwankyu commented Dec 6, 2023

Thanks!

vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 10, 2023
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

for those who want to play with Sage instantly, and also as a
preparation for sagemath#36245.

See this [REAME.md](https://github.com/kwankyu/sage/tree/p/add-binder-
badge-to-readme).

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36815
Reported by: Kwankyu Lee
Reviewer(s): Matthias Köppe
@vbraun vbraun merged commit c7443b1 into sagemath:develop Dec 14, 2023
14 of 18 checks passed
@mkoeppe mkoeppe added this to the sage-10.3 milestone Dec 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants