This repository is a part of the REUSE project and shows an example repository which is compliant to the REUSE best practices for making copyrights and licenses computer readable.

Jonas Oberg 9eeeb0f597 Updated README to have correct title 3 weeks ago
LICENSES Making the initial commit 3 weeks ago
hooks Making the initial commit 3 weeks ago
src Making the initial commit 3 weeks ago
.gitignore Making the initial commit 3 weeks ago
LICENSE.spdx Updated README to have correct title 3 weeks ago
README.md Updated README to have correct title 3 weeks ago
README.md.license Making the initial commit 3 weeks ago

README.md

REUSE Hello (SPDX)

reuse compliant standard-readme compliant

This repository is a part of the REUSE project and shows an example repository which is compliant to the REUSE best practices for making copyrights and licenses computer readable. It can be used as inspiration and for reference, to see what a repository following the practices would look like.

The difference between this version, and the others examples, is that this repository includes code copyright by another organisation and thus includes both MIT and GPLv3 licensed material. It also has Git commit hooks which generate an SPDX file automatically from included files.

Install

To install Hello World, simply copy the file src/server.js to a convenient location, or (even better!) keep it in the repository.

Usage

To run the server, listening on the default port (8082), simply run it from the src/ directory as such:

$ cd src
$ node server.js

Visit http://localhost:8082/ to receive your Hello World greeting, after starting the server.

Contribute

To contribute to this project, please fork the repository at http://git.fsfe.org/reuse/hello-simple and make your contribution to the fork, then open a pull request to initiate a discussion around the contribution.

Hooks

In order to contribute successfully to this project, if you have commit access to the repository, you must make sure to install the Git hooks which are in the hooks/ directory, so that they run when you make a commit.

These hooks ensure the lint-bom tool is run to generate an SPDX file for the repository, using the most reliable information available at the time of your commit. Please update the hooks according to where lint-bom is installed on your machine.

For information about lint-bom check out https://git.fsfe.org/reuse/lint/

To install the hooks, as they are, do this:

$ ln -rs hooks/pre-commit .git/hooks/
$ ln -rs hooks/post-commit .git/hooks/

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.

The program in this repository meet the requirements to be REUSE compliant, meaning its license and copyright is expressed in such as way so that it can be read by both humans and computers alike.

For more information, see https://reuse.software/