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

MAINT: Added LICENSE and updated README #59

Merged
merged 7 commits into from
Apr 25, 2024

Conversation

Schefflera-Arboricola
Copy link
Member

As suggested by @rossbar in the last nx-community meeting I've added the installation instructions in the readme. I updated the readme with a few other changes as well. I also added the CC0 1.0 Universal license. LMK know what you think of that. Also, I tried following through the instructions in RELEASE.md but I couldn’t bcoz I don’t have the GH_TOKEN

RuntimeError: You need to set the environment variable `GH_TOKEN`. The token is used to avoid rate limiting, and can be created at https://github.com/settings/tokens.

And I decided to remove the link to the _dispatchable decorator's docs because it will probably be moved around in the future and instead put the backend doc's page's link.

Thank you :)

@jarrodmillman
Copy link
Member

Why not use a BSD-3 license?

@Schefflera-Arboricola
Copy link
Member Author

Why not use a BSD-3 license?

I'm not an expert in this but I choose to go with CC0 1.0 Universal license because I know that it has the least restrictions, also nx-guides use it so I thought maybe projects other than the main networkx project(in networkx org) use this license. Let me know if the BSD-3 or BSD-3-Clause or any other license would be more appropriate for this project and I'll change it. thanks!

@rossbar
Copy link
Collaborator

rossbar commented Apr 14, 2024

FWIW the reason nx-guides uses a CC license instead because the majority of the content is narrative text instead of code. I think BSD-3 is more appropriate here - just my 2 cents!

@dschult
Copy link
Member

dschult commented Apr 15, 2024

That is my understanding as well -- that CC is better for prose/text while BSD is better for code.
So, let's match the NetworkX license rather than the nx-guides license. :)

Copy link
Member

@dschult dschult left a comment

Choose a reason for hiding this comment

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

Looks good oto me!

@dschult dschult merged commit 969941b into networkx:main Apr 25, 2024
11 checks passed
@jarrodmillman jarrodmillman added this to the 0.1 milestone Apr 25, 2024
@jarrodmillman jarrodmillman modified the milestones: 0.1, 0.2 May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

4 participants