===================================
Network Administration Visualized

.. image:: https://img.shields.io/github/actions/workflow/status/Uninett/nav/build-and-test.yml?branch=master
:alt: GitHub Workflow Status
:target: https://github.com/Uninett/nav/actions
.. image:: https://codecov.io/gh/Uninett/nav/branch/master/graph/badge.svg?token=0o6wdrEwne
:alt: Code coverage
:target: https://codecov.io/gh/Uninett/nav
.. image:: https://readthedocs.org/projects/nav/badge/?version=latest&style=flat
:target: https://nav.readthedocs.io/en/latest/
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:alt: Linting and formatting
:target: https://github.com/astral-sh/ruff

This is NAV - Network Administration Visualized - an advanced software suite
to monitor small and large computer networks.

:Homepage: https://nav.uninett.no/
:Documentation: https://nav.readthedocs.io/en/latest/
:Bug tracker and release management: https://github.com/Uninett/nav

License

NAV is licensed under the GNU GPL version 3. NAV includes software from third
parties, which are either licensed under the GPL or compatible licenses.

• Copyright 2002-2021 Uninett AS
• Copyright 2022-2026 Sikt

See individual source files for more detailed copyright notices.

3rd parties

Some of the graphics icons come altered and/or unaltered from the Tango Icon
Library (http://tango.freedesktop.org/) or other public domain collections.
Most of these are licensed under the Creative Commons Attribution Share-Alike
license (http://creativecommons.org/licenses/by-sa/2.5/).

This product includes color specifications and designs developed by Cynthia
Brewer (http://colorbrewer.org/). These color schemes are Copyright (c) 2002
Cynthia Brewer, Mark Harrower, and The Pennsylvania State University and are
licensed under the Apache License v2.0.


Installation
------------
For detailed instructions on how to install NAV, see
`<doc/intro/install.rst>`_. See the file `<NOTES.rst>`_ for release notes and
upgrade instructions.

Take it for a quick spin
------------------------
For instruction on how to use docker to run code straight from the repo, see
`<doc/hacking/using-docker.rst>`_.  Please be aware, though, that this is a highly developer-oriented environment, and is not suitable for production use.

Contributing
------------
For instructions on how to contribute to NAV, please read
`<doc/hacking/hacking.rst>`_ .