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

[Feature] Getting Started Section of README.md #1247

Closed
1 task
jamesbraza opened this issue Sep 1, 2022 · 2 comments
Closed
1 task

[Feature] Getting Started Section of README.md #1247

jamesbraza opened this issue Sep 1, 2022 · 2 comments
Assignees
Labels
🕹 aspect: interface Concerns end-users' experience with the software 📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature 🟨 priority: medium Not blocking but should be fixed soon 🏁 status: ready for work Ready for work

Comments

@jamesbraza
Copy link

Problem

I am trying to make a blog website hosted via GitHub Pages with a CC BY-SA 4.0 license.

santisoler/cc-licenses has a LICENSE file available for individuals to copy and add to their respective repos. However, santisoler/cc-licenses#9 is currently open to remove the licenses in favor of this repo. So I am trying to get the LICENSE file from here.

Looking at this repo's current README.md, I have no idea how to get a LICENSE file to add to my GitHub repo. Going to docroot/legalcode, I see nothing but HTML files. I am looking for a plaintext LICENSE file.

Description

Can you add a section to the README.md talking about how to "get started" with this repo, and adding a LICENSE to one's own GitHub repo?

I am a software engineer (no legal background) and get intimidated by legalese. So "beginner friendly" wording is much appreciated :)

Alternatives

Additional context

Implementation

  • I would be interested in implementing this feature.
@jamesbraza jamesbraza added ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed labels Sep 1, 2022
@TimidRobot TimidRobot self-assigned this Sep 1, 2022
@TimidRobot TimidRobot added 🟨 priority: medium Not blocking but should be fixed soon 🏁 status: ready for work Ready for work 📄 aspect: text Concerns the textual material in the repository 🕹 aspect: interface Concerns end-users' experience with the software and removed 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 💻 aspect: code Concerns the software code in the repository labels Sep 1, 2022
@TimidRobot
Copy link
Member

TimidRobot commented Sep 1, 2022

Plain Text License Files

@jamesbraza You can download the plaintext licenses for use in a LICENSE file here:

For example: https://github.com/creativecommons/stateof/blob/main/LICENSE

Also, please note that the CC Licenses are not recommended for software. The CC0 public domain dedication is: Using CC0 for public domain software - Creative Commons.

Background and Context

This repository currently contains the canonical location for the plain text license files. They are in the docroot/legalcode/ directory. In the near future, this repository will be deprecated and replaced by creativecommons/cc-legal-tools-data.

The lack of discoverability / poor user experience is a known issue: Improve support of CC Licensed GitHub repositories · Issue #120 · creativecommons/cc-legal-tools-app.

@jamesbraza
Copy link
Author

Thank you for the detailed response @TimidRobot, and good to know about use of CC licenses for software. Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software 📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature 🟨 priority: medium Not blocking but should be fixed soon 🏁 status: ready for work Ready for work
Projects
None yet
Development

No branches or pull requests

2 participants