nimble

<!--
SPDX-FileCopyrightText: 2020-2023 Eric Nitschke <eric@wakoma.co>
SPDX-FileCopyrightText: 2023 Robin Vobruba <hoijui.quaero@gmail.com>

SPDX-License-Identifier: CERN-OHL-S-2.0
-->

# nimble

[![License: CERN-OHL-S-2.0](
    https://img.shields.io/badge/License-CERN--OHL--S--2.0-blue.svg)](
    https://spdx.org/licenses/CERN-OHL-S-2.0.html)
[![REUSE status](
    https://api.reuse.software/badge/github.com/Wakoma/nimble)](
    https://api.reuse.software/info/github.com/Wakoma/nimble)

An open source, rapidly deployable, wireless mesh network.

Anyone connected to the nimble can video and voice chat, stream videos, share files, build and run eLearning courses and website, create collaborative spreadsheets and documents, read e-books, play games, and so much more… completely offline.

If a single internet connection is available, it can be plugged into the nimble to provide free or paid internet access to anyone on the network. The offline services and content are always available to users, regardless of internet availability.

Anyone in the world can build their own nimble with locally sourced hardware and 3D-printed components.

* [nimble Website](https://wakoma.co/nimble/)
* [Zotero Library](https://www.zotero.org/groups/2403673/communitynetworks/library)
* [CadOrchestrator](https://gitlab.com/gitbuilding/cadorchestrator)

<p align="center"><img alt="6in NUC shelf" src="https://raw.githubusercontent.com/Wakoma/nimble/refs/heads/master/assets/img/Model_M/36.jpg" height="auto" width="800"></p>

## State of this repository

We are excited to announce that we have received a grant from NLnet Foundation! With this generous funding our team is working with several incredible partners from the open hardware community to develop a smart documentation system which automatically generates all documentation and 3D models needed for any custom nimble configuration. 

A sneek preview of the nimble builder:

<p align="center"><img alt="6in NUC shelf" src="https://gitlab.com/gitbuilding/cadorchestrator/-/raw/master/assets/UIexample.png" height="auto" width="800"></p>



This repository is in transition as we work towards the Smart-Doc goals of making all of the mechanical models parametric, and automatically generating the documentation for any configuration. To see repository before these changes, see the [post-hackathon release](https://github.com/Wakoma/nimble/releases/tag/Post-hackathon). This was the Nimble repository after the great work done at the [Open Toolchain Foundation](https://forum.opentoolchain.org/) hackathon.

For more information on our project please see:

* Jeremy's blog post: [First Nimble Project Update](https://7bindustries.com/blog/nimble_project_1.html)
* This project is funded by  NLnet Foundation! See their announcemnt [here](https://nlnet.nl/project/HardwareManuals/).


<p align="center"><img alt="6in NUC shelf" src="https://nlnet.nl/logo/banner.png" height="auto" width="500"></p>


## Generating models locally

You can run the nimble code on your own computer. [Find out more about local model generation](generate.md)


## Important Links

* [Nimble website](https://wakoma.co/nimble/)
* [Nimble printables page](https://www.printables.com/model/80708-wakoma-nimble-new-2021-model)
* [State of this repository after the OTFN hackathon](https://github.com/Wakoma/nimble/releases/tag/Post-hackathon)

## Support

For more info have a look at <https://wakoma.co/nimble>,
or reach out to <mailto:info@wakoma.co>.


<p align="center"><img alt="6in NUC shelf" src="https://raw.githubusercontent.com/Wakoma/nimble/refs/heads/master/assets/img/mesh_big.png" height="auto" width="800"></p>