codergeek42 / wordle-solver

A clever algorithm and automated tool to solve the NYTimes daily Wordle puzzle game.
GNU General Public License v3.0
0 stars 0 forks source link

Add GPL-3 notice to all source files #59

Closed codergeek42 closed 5 days ago

codergeek42 commented 5 days ago

Although the current LICENSE inclusion makes clear that this is under the GPL-3.0 "copyleft" license; the preamble should be added to each source file just to be explicitly clear.

Suggested preamble text, from the GPL-3.0 itself with software and author name filled in:

    wordle-solver: A clever algorithm and automated tool to solve the NYTimes daily Wordle puzzle game.
    Copyright (C) 2023 Peter Gordon <codergeek42@gmail.com>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program, namely the "LICENSE" text file.  If not,
    see <https://www.gnu.org/licenses/gpl-3.0.html>.

Acceptance Criteria This preamble is added a code comment to each source file:

codergeek42 commented 5 days ago

For posterity: File list as checkboxes markdown generated by CLI:

$ cd wordle-solver
$ find .  -iregex '.*\.[cm]?[tj]s$' | sed -e 's!^\./!- [ ] !g'
codergeek42 commented 5 days ago

For posterity: Formatted preamble as TS/JS comment:

/*****
 * wordle-solver: A clever algorithm and automated tool to solve the
 *  NYTimes daily Wordle puzzle game.
 * Copyright (C) 2023 Peter Gordon <codergeek42@gmail.com>
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program, namely the "LICENSE" text file.  If not,
 * see <https://www.gnu.org/licenses/gpl-3.0.html>.
 *****/