Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fill in project README file #78

Merged
merged 2 commits into from
Oct 4, 2023
Merged

Fill in project README file #78

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e94a84
Fill in project README file
Sep 28, 2023
738de59
Final touches
Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 34 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,45 @@
<div align="center">

# MicroOVN

MicroOVN is [snap-deployed OVN][charmhub-microovn] with built-in clustering.
[Open Virtual Network][upstream-ovn] (OVN) is an SDN platform that is often
MicroOVN is [snap-deployed OVN][snapstore-microovn] with built-in clustering.
[Open Virtual Network][upstream-ovn] (OVN) is an SDN platform that is commonly
used with enterprise-grade cloud solutions.

## Documentation
</div>

## 📖 Documentation

The documentation is found in the [`docs`][docs-dir-microovn] directory. It is
written in RST format, built with Sphinx, and published on Read The Docs:

[MicroOVN documentation][rtd-microovn]

## 💫 Project & community

* [Join our online forum][ubuntu-discourse-microovn]
* [Contributing guidelines][contrib-microovn]
* [Code of conduct][ubuntu-coc]
* [File a bug][bug-microovn]

You can ask for technical help in the [Support][ubuntu-discourse-microovn-support]
sub-category in the above forum.

## 📰 License

The documentation is found in the [docs][docs-dir-microovn] directory. It is
written in RST format and built with Sphinx. It is published on Read The Docs
[here][rtd-microovn].
MicroOVN is free software, distributed under the AGPLv3 license (GNU Affero
General Public License version 3.0). Refer to the [COPYING][license-microovn]
file (the actual license) for more information.

<!-- LINKS -->

[charmhub-microovn]: https://snapcraft.io/microovn
[snapstore-microovn]: https://snapcraft.io/microovn
[upstream-ovn]: https://www.ovn.org/
[rtd-microovn]: https://canonical-microovn.readthedocs-hosted.com/
[docs-dir-microovn]: https://github.com/canonical/microovn/tree/main/docs
[ubuntu-discourse-microovn]: https://discourse.ubuntu.com/c/microovn/160
[ubuntu-discourse-microovn-support]: https://discourse.ubuntu.com/c/microovn/support/164
[contrib-microovn]: ./CONTRIBUTING.md
[license-microovn]: ./COPYING
[ubuntu-coc]: https://ubuntu.com/community/ethos/code-of-conduct
[bug-microovn]: https://bugs.launchpad.net/microovn/+filebug