Verified Commit 4d6ab020 authored by s1udge's avatar s1udge 💬

added licenses, readme and revised contributing.

parent 145045b6
2019/06/26
- revised README, license
2019/04/23
- updated Contributing, README, and FAQ
......
......@@ -7,7 +7,7 @@ distributed by the Parrot Project, You reserve all right, title, and interest in
Your Contributions. All Contributions are subject to the following DCO + License
terms.
[DCO + Licenses](LICENSES.md)
[DCO + Licenses](LICENSE.md)
_This notice should stay as the first item in the CONTRIBUTING.md file._
......@@ -21,7 +21,7 @@ Please email `security at parrotsec dot org` or send Palinuro a PM on Telegram.
You can help improve our documentation by submitting merge requests (pull requests in github) to this repository.
For more information about how to contribute please see our [Technical Guidelines for Contributing](https://nest.parrotsec.org/parrot-organization/community/blob/master/Tech-GL-4C.md).
For more information about how to contribute please see our [Technical Guidelines for Contributing](https://nest.parrotsec.org/parrot-organization/community-team/community/blob/master/Tech-GL-4C.md).
We want to create a welcome environment for everyone who is interested in contributing. Please see our [Code of Conduct](https://nest.parrotsec.org/parrot-organization/community/blob/master/code-of-conduct.md) to learn more about our committment to an open environment.
......
## Developer Certificate of Origin + Licenses
**By contributing to the Parrot Project, you accept and agree to the following terms and conditions for your present and future Contributions submitted to the Parrot Project.**
Except for the license granted herein to Parrot Project and recipients of software distributed by Parrot Project, You reserve all right, title, and interest in and to your Contributions.
## Developer Certificate of Origin
```text
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
```
**All Contributions to Parrot Project repositories are licensed under the following licenses:**
## Software and code
1) [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html)
Copyright 2007-Present time, Lorenzo "Palinuro" Faletra
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## Everything else
2) [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
Copyright 2007-Present time, Lorenzo "Palinuro" Faletra
All Documentation, artwork and any media not covered by the license above, is licensed under Creative Commons: CC BY-SA 4.0.
**Note:** Palinuro is the current copyright and license holder for the Parrot Project as a temporary measure. All licenses and copyrights will eventually be transfered to a non-profit we are setting up to enable better transparency (we hope to have more details in the fall of 2019).
# Parrot Project's Documentation Portal
This Project contains the majority of Parrot's documentation for ParrotOS and the Parrot Project. Currently this Repository is not prepared for CI/CD but we hope to change that in the near future. If you wish to contribute please read thoroughly before doing so and thanks for reading!
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. To contribute see [contributing.md](CONTRIBUTING.md).
### Prerequisites
- A Linux OS which can run MkDocs
- MkDocs
- Python2/3 (all the pythons!)
- pip
- some knowledge of git, ssh, markdown, yaml and MkDocs
### Installing
- Install Mkdocs (typically with pip)
- Install the cyborg theme
### Testing
Verify Mkdocs builds documentation. Take note of any errors. Serve locally on 127.0.0.1:8000 check out your changes and make sure things are working properly. Fix any errors you get and rebuild and serve error-free before submitting a merge request.
## Built With
* [MkDocs](https://www.mkdocs.org/) - Project documentation with Markdown.
* [Bootswatch Cyborg theme](https://mkdocs.github.io/mkdocs-bootswatch/#cyborg) - Theme used for documentation.
* [Gitlab](https://gitlab.com/gitlab-org/gitlab-ce) - a single application for the entire software development lifecycle.
* [Codium/VSCodium](https://vscodium.github.io/) - Free/Libre Open Source Software Binaries of VSCode.
* Coffee and the closely held tears of people who scream "Help me now!" until they pass out from low blood sugar.
**Documentation**
* [Open Source Guide](https://opensource.guide) Content based on [github.com/github/opensource.guide](github.com/github/opensource.guide) used under the CC-BY-4.0 license.
## Contributing
Please read [CONTRIBUTING](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting merge requests (pull requests) or making contributions.
## Authors
| Nickname | Name | Email |
| ---------------- | ------------------ | --------------------------------- |
| palinuro | Lorenzo Faletra | palinuro at parrotsec dot org |
| Jeff | Jeff Szydel | jeff at parrotsec dot org |
| s1udge | | s1udge at parrotsec dot org |
| h0tw4t3r | | h0tw4t3r at parrotsec dot org |
| Dm Knght | Nông Hoàng Tú | dmknght at protonmail dot com |
| terabreik | Jose Gatica | josegatica at parrotsec dot org |
| disrupt_the_flow | | disrupt_the_flow at parrotsec dot org |
| meu | M. Emrah Ünsür | meu at parrotsec dot org |
| KileXt | | |
| Serverket | Manuel Hernandez | |
## Licenses
This project is licensed under the GPLv3 and CC-BY-SA v4.0 Licenses - see the [LICENSE.md](LICENSE.md) file for details.
## Acknowledgments
* Big thank you to [PurpleBooth](https://github.com/PurpleBooth) for her [README template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2).
* Thanks to [Github](https://github.com/github/opensource.guide) and the [contributors](https://github.com/github/opensource.guide/graphs/contributors) for their [Open Source Guide](https://opensource.guide).
* Thank you, to all the teachers who taught us the eloquence of language.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment