Browse Source

README: update according to common template

The current README seems to have been a copy of the
one found in the Mender client repository which contains
som information about Yocto and other things which are not
relavant to this repository.

Changelog: None

Signed-off-by: Mirza Krak <mirza.krak@northern.tech>
1.0.x
Mirza Krak 6 years ago
parent
commit
bbf1eb5c66
  1. 41
      README.md

41
README.md

@ -1,40 +1,17 @@
Mender: over-the-air updater for embedded Linux devices
==============================================
Mender Conversion Tool
======================
Mender is an open source over-the-air (OTA) software updater for embedded Linux
devices. Mender comprises a client running at the embedded device, as well as
a server that manages deployments across many devices.
Mender is an open source over-the-air (OTA) software updater for embedded Linux devices. Mender comprises a client running at the embedded device, as well as a server that manages deployments across many devices.
Embedded product teams often end up creating homegrown updaters at the last
minute due to the need to fix bugs in field-deployed devices. However, the most
important requirement for an embedded update process is *robustness*, for example
loss of power at any time should not brick a device. This creates a challenge
given the time constraints to develop and maintain a homegrown updater.
This repository contains the Mender Conversion Tool, which is used to convert pre-built disk images (Debian, Ubuntu, Raspbian, etc) to a Mender compatible
image by restructuring partition table and injecting the necessary files.
Mender aims to address this challenge with a *robust* and *easy to use* updater
for embedded Linux devices, which is open source and available to anyone.
![Mender logo](https://mender.io/user/pages/05.resources/06.digital-assets/logo.png)
Robustness is ensured with *atomic* image-based deployments using a dual A/B
rootfs partition layout. This makes it always possible to roll back to a working state, even
when losing power at any time during the update process.
## Getting started
Ease of use is addressed with an intuitive UI, [comprehensive documentation](https://docs.mender.io/), a
[meta layer for the Yocto Project](https://github.com/mendersoftware/meta-mender) for *easy integration into existing environments*,
and high quality software (see the test coverage badge).
This repository contains the Mender client updater, which can be run in standalone mode
(manually triggered through its command line interface) or managed mode (connected to the Mender server).
Mender not only provides the client-side updater, but also the backend and UI
for managing deployments as open source. The Mender server is
designed as a microservices architecture and comprises several repositories.
## Generic conversion tool
A tool for taking an existing embedded image (Debian, Ubuntu, Raspbian, etc) and converting it to a Mender image by restructuring partition table and adding necessary files.
Since we are unlikely to be able to patch U-Boot this way, this depends on U-Boot/UEFI functionality.
To start using Mender, we recommend that you begin with the Getting started
section in [the Mender documentation](https://docs.mender.io/).
## Contributing

Loading…
Cancel
Save