{project_name}
_{tagline}

💾 Install • 🎮 Quick start • 🐋 Docker • 🐝 API • 🔧 Configuration • 📋 Testing • 🐛 Troubleshooting & debugging • 😍 Acknowledgements • 🌐 Links • 👤 Contributing • 💼 License

Abstract description like: 🚧 Zenroom is a software in ALPHA stage and are part of the DECODE project about data-ownership and technological sovereignty. Our effort is that of improving people's awareness of how their data is processed by algorithms, as well facilitate the work of developers to create along privacy by design principles using algorithms that can be deployed in any situation without any change.

🚩 Table of Contents (click to expand)

• Install
• Quick start
• Docker
• API
• Configuration
• Testing
• Troubleshooting & debugging
• Acknowledgements
• Links
• Contributing
• License

---

💾 Install

pip install / yard add {project_name}

---

🎮 Quick start

Use just run just to see al targets

start

starts the whole Docker situation

bash

Login to the docker container, hence you can play and run commands on the guest machine

---

🐋 Docker

cargo install cargo-make
cargo make start

Enter the shell of the container

cargo make shell

🔝 back to top

---

🐝 API

🔝 back to top

---

🔧 Configuration

🔝 back to top

---

📋 Testing

🔝 back to top

---

🐛 Troubleshooting & debugging

🔝 back to top

---

😍 Acknowledgements

Copyleft (ɔ) 2021 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi.

Special thanks to Mr. W. White for his special contributions.

🔝 back to top

---

🌐 Links

https://www.somelink.io/

https://dyne.org/

🔝 back to top

---

👤 Contributing

Please first take a look at the Dyne.org - Contributor License Agreement then

1. 🔀 FORK IT
2. Create your feature branch git checkout -b feature/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
6. 🙏 Thank you

🔝 back to top

---

💼 License

{project_name} - {tagline}
Copyleft (ɔ) 2021 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/>.

🔝 back to top