gfgit
/
Heimdall
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

README: re-format, re-phrase supported platform section 

And use https for external links.
This commit is contained in:
Henrik Grimler 2021-05-03 13:56:09 +02:00
parent 6ede1f1f33
commit 54d58b8244
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1,38 +1,42 @@
# Heimdall
Heimdall is a cross-platform open-source tool suite used to flash firmware (aka ROMs) onto Samsung mobile devices.
Heimdall is a cross-platform open-source tool suite used to flash
firmware (aka ROMs) onto Samsung mobile devices.
## Supported Platforms
Officially, AMD64/x86-64 (64-bit) or x86 (32-bit) computers running:
Heimdall should work on AMD64/x86-64 (64-bit) or x86 (32-bit)
computers running GNU/Linux, macOS or Windows.
* Linux
* macOS
* Windows (XP, Vista, 7 etc.)
However, several third-parties have reported success running Heimdall on ARM chipsets
(in particular Raspberry Pi), as well as additional operating systems such as FreeBSD.
However, several third-parties have reported success running Heimdall
on ARM chipsets (in particular Raspberry Pi), as well as additional
operating systems such as FreeBSD.
## How does Heimdall work?
Heimdall connects to a mobile device over USB and interacts with low-level software
running on the device, known as Loke. Loke and Heimdall communicate via the custom
Samsung-developed protocol typically referred to as the 'Odin 3 protocol'.
Heimdall connects to a mobile device over USB and interacts with
low-level software running on the device, known as Loke. Loke and
Heimdall communicate via the custom Samsung-developed protocol
typically referred to as the 'Odin 3 protocol'.
USB communication in Heimdall is handled by the popular open-source USB library, [libusb](http://libusb.info).
USB communication in Heimdall is handled by the popular open-source
USB library, [libusb](http://libusb.info).
## Free & Open Source
Heimdall is both free and open source. It is licensed under the MIT license (see LICENSE).
Heimdall is both free and open source. It is licensed under the MIT
license (see LICENSE).
Heimdall is maintained and predominantly developed by [Glass Echidna](http://glassechidna.com.au/),
a _tiny_ independent software development company. If you appreciate our work and would like
to support future development please consider making a [donation](http://glassechidna.com.au/donate/).
Heimdall is maintained and predominantly developed by [Glass
Echidna](https://glassechidna.com.au/), a _tiny_ independent software
development company. If you appreciate our work and would like to
support future development please consider making a
[donation](https://glassechidna.com.au/donate/).
## Documentation
For more details about how to compile and install Heimdall please refer to the
appropriate platform specific README:
For more details about how to compile and install Heimdall please
refer to the appropriate platform specific README:
#### Linux