commit 6fd2a3765caacb73a84eca34362486fdcd887c0f
parent 612a24ea84f60428a7998c9b6aaa58e0f0ccae10
Author: Jaromil <jaromil@dyne.org>
Date: Sun, 10 Jul 2022 20:01:11 +0200
documentation updates
Diffstat:
| M | .gitignore | | | 1 | + |
| A | CONTRIBUTING.md | | | 36 | ++++++++++++++++++++++++++++++++++++ |
| M | README.md | | | 172 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---- |
3 files changed, 201 insertions(+), 8 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,7 @@
# license and readme
!/LICENSE
!/README.md
+!/CONTRIBUTING.md
# useful things
!/.iex.exs
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,36 @@
+# Dyne.org - Contributor License Agreement
+
+This Contributor Agreement (“CA”) applies to the contribution specified in section "Terms" below that you make to any product or project managed by us (the “project”), and sets out the intellectual property rights you grant to us in the contributed materials. The term “us” shall mean Dyne.org Foundation. The term “you” shall mean the person or entity identified below. If you agree to be bound by these terms, fill in the information requested and [sign the Dyne.org CA](https://dyne.org/cla). Read this agreement carefully before signing. These terms and conditions constitute a binding legal agreement.
+
+## Terms
+
+The term 'contribution' or ‘contributed materials’ means the following: any source code, object code, patch, tool, sample, graphic, specification, manual, documentation, or any other material posted or submitted by you to the Zenroom stack and/or any project owned by us, publicly or privately distributed.
+
+## Copyrights
+
+With respect to any worldwide copyrights, or copyright applications and registrations, in your contribution:
+ - you hereby grant to us a perpetual, irrevocable, non-exclusive, worldwide, no-charge, royalty-free, unrestricted license to exercise all rights under those copyrights. This includes, at our option, the right to sublicense these same rights to third parties through multiple levels of sublicensees or other licensing arrangements;
+ - you agree that each of us can do all things in relation to your contribution as if each of us were the sole owners, and if one of us makes a derivative work of your contribution, the one who makes the derivative work (or has it made) will be the sole owner of that derivative work;
+ - you agree that you will not assert any moral rights in your contribution against us, our licensees or transferees;
+ - you agree that we may register a copyright in your contribution and exercise all ownership rights associated with it; and
+ - you agree that neither of us has any duty to consult with, obtain the consent of, pay or render an accounting to the other for any use or distribution of your contribution.
+
+## Patents
+
+With respect to any patents you own, or that you can license without payment to any third party, you hereby grant to us a perpetual, irrevocable, non-exclusive, worldwide, no-charge, royalty-free license to:
+ - make, have made, use, sell, offer to sell, import, and otherwise transfer your contribution in whole or in part, alone or in combination with or included in any product, work or materials arising out of the project to which your contribution was submitted, and
+ - at our option, to sublicense these same rights to third parties through multiple levels of sublicensees or other licensing arrangements.
+
+## Free availability
+
+Except as set out above, you keep all right, title, and interest in your contribution. The rights that you grant to us under these terms are effective on the date you first submitted a contribution to us, even if your submission took place before the date you sign these terms. Any contribution we make available under any license will also be made available under a suitable FSF (Free Software Foundation) or DECODE project's approved license.
+
+## Covenant
+
+You covenant, represent, warrant and agree that:
+ - each contribution that you submit is and shall be an original work of authorship and you can legally grant the rights set out in this CA;
+ - to the best of your knowledge, each contribution will not violate any third party's copyrights, trademarks, patents, or other intellectual property rights; and You agree to notify us if you become aware of any circumstance which would make any of the foregoing representations inaccurate in any respect. We may publicly disclose your participation in the project, including the fact that you have signed the CA.
+
+## Jurisdiction
+
+This CA is governed by the laws of the courts of Amsterdam and applicable to Dutch laws. Any choice of law rules will not apply.
diff --git a/README.md b/README.md
@@ -1,19 +1,175 @@
-# Zenflows
+<h1 align="center">
+ Zenflows - GraphQL implementation of the [Valueflows](https://www.valueflo.ws) vocabulary</br>
+ <sub></sub>
+</h1>
-Zenflows is a back-end software implementing the [Valueflows
-vocabulary](https://www.valueflo.ws/).
+<p align="center">
+ <a href="https://dyne.org">
+ <img src="https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%9D%A4%20by-Dyne.org-blue.svg" alt="Dyne.org">
+ </a>
+</p>
+<br><br>
-## Quick start
+<h4 align="center">
+ <a href="#-quick-start">🎮 Quick start</a>
+ <span> • </span>
+ <a href="#-install">💾 Install</a>
+ <span> • </span>
+ <a href="#-configuration">🔧 Configuration</a>
+ <span> • </span>
+ <a href="#-testing">📋 Testing</a>
+ <span> • </span>
+ <a href="#-styleguide">📘 Styleguide</a>
+ <span> • </span>
+ <a href="#-troubleshooting--debugging">🐛 Troubleshooting & debugging</a>
+ <span> • </span>
+ <a href="#-acknowledgements">😍 Acknowledgements</a>
+ <span> • </span>
+ <a href="#-links">🌐 Links</a>
+ <span> • </span>
+ <a href="#-contributing">👤 Contributing</a>
+ <span> • </span>
+ <a href="#-license">💼 License</a>
+</h4>
+
+
+Abstract description like: 🚧 Zenflows is a software in **ALPHA
+stage** and is part of the [INTERFACER project](https://www.interfacerproject.eu).
+
+Zenflows is a tool to leverage commons-based peer production by
+documenting and monitoring the life cycle of products. The goal is
+that of enabling a federated network of organizations to bundle,
+systematize and share data, information and knowledge about physical
+artifacts.
+
+Zenflows features [Zenroom](https://zenroom.org) as core crypto
+component to implement advanced Digital Product Passport schemes using
+[REFLOW Portable Crypto Functions](https://medium.com/think-do-tank/reflow-crypto-material-passports-for-the-circular-economy-d75b3aa63678).
+
+
+<details id="toc">
+ <summary><strong>🚩 Table of Contents</strong> (click to expand)</summary>
+
+* [Quick start](#-quick-start)
+* [Install](#-install)
+* [Configuration](#-configuration)
+* [Testing](#-testing)
+* [Styleguide](#-styleguide)
+* [Troubleshooting & debugging](#-troubleshooting--debugging)
+* [Acknowledgements](#-acknowledgements)
+* [Links](#-links)
+* [Contributing](#-contributing)
+* [License](#-license)
+</details>
+
+## 🎮 Quick start
+
+To start using Zenflows
1. Run `./mann env.setup` to generate the configuration file, `conf/env.sh`.
-2. Edit `conf/env.sh` to suit your needs. Read the [Configuration
- Guide](docs/configuration-guide.md) for more info.
+2. Edit `conf/env.sh` to suit your needs. Read the [Configuration Guide](docs/configuration-guide.md) for more info.
3. Run `./mann db.setup` to setup the database and run the migrations.
4. Run `./mann run` to start the application.
5. Head over to [`http://localhost:4000/play`](http://localhost:4000/play) for the GraphQL playground.
+**[🔝 back to top](#toc)**
+
+***
+## 💾 Install
+
+🚧 TODO
+
+**[🔝 back to top](#toc)**
+
+***
+## 🔧 Configuration
+
+**[🔝 back to top](#toc)**
+
+***
+
+## 📋 Testing
+
+**[🔝 back to top](#toc)**
+
+***
+## 📘 Styleguide
+
+* Use tabs for indentation, spaces for aligment.
+* Don't indent the top-level code in modules.
+* Use trailing commas in multi-line lists, maps, functions, etc. where
+ possible.
+
+**[🔝 back to top](#toc)**
+
+***
+## 🐛 Troubleshooting & debugging
+
+**[🔝 back to top](#toc)**
+
+***
+## 😍 Acknowledgements
+
+[](http://www.dyne.org)
+
+Copyleft (ɔ) 2021-2022 by [Dyne.org](https://www.dyne.org) foundation, Amsterdam
+
+Designed, written and maintained by [srfsh](/srfsh) with the help of [jaromil](/jaromil), [puria](/puria).
+
+Reviews and suggestions contributed by [Lynn](/fosterlynn), [Bob](/bhaugen), and members of the Valueflows community.
+
+<img src="https://upload.wikimedia.org/wikipedia/commons/8/84/European_Commission.svg"
+ width="190" alt="Project funded by the European Commission">
+
+This project is receiving funding from the European Regional Development Fund (ERDF).
+
+**[🔝 back to top](#toc)**
+
+***
+## 🌐 Links
+
+https://dyne.org/
+
+https://reflowproject.eu
+
+https://www.valueflo.ws/
+
+**[🔝 back to top](#toc)**
+
+***
+## 👤 Contributing
+
+Please first take a look at the
+[Dyne.org - Contributor License Agreement](CONTRIBUTING.md) then
+
+1. 🔀 [FORK IT](../../fork)
+2. Create your feature branch `git checkout -b feat/branch`
+3. Commit your changes `git commit -am 'Add some fooBar'`
+4. Push to the branch `git push origin feature/branch`
+5. Create a new Pull Request `gh pr create -f`
+6. 🙏 Thank you
+
+
+**[🔝 back to top](#toc)**
+
+***
+## 💼 License
+ Zenflows - Valueflows vocabulary
+ Copyright (c) 2021-2022 Dyne.org foundation, Amsterdam
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
-## Licensing and copying
-See the [LICENSE](LICENSE) file for copyright and license details.
+**[🔝 back to top](#toc)**
