mirror of
https://review.coreboot.org/flashrom.git
synced 2025-11-13 19:20:41 +01:00
4b370bebb7
COPYING file existed in the tree for a very long time, but now we also have a website which is generated from the docs in the tree. This patch adds a page to display content of the COPYING file on the website. The file stays in the tree, it just got slight formatting added to convert it to rst format. No changes to the text, just formatting (headings, paragraphs etc). Change-Id: Ieb05d61ccc1b66e9ce91b7dfa18672a4da7db52c Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/89278 Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
flashrom README
===============
flashrom is a utility for detecting, reading, writing, verifying and erasing
flash chips. It is often used to flash BIOS/EFI/coreboot/firmware images
in-system using a supported mainboard, but it also supports flashing of network
cards (NICs), SATA controller cards, and other external devices which can
program flash chips.
It supports a wide range of flash chips (most commonly found in SOIC8, DIP8,
SOIC16, WSON8, PLCC32, DIP32, TSOP32, and TSOP40 packages), which use various
protocols such as LPC, FWH, parallel flash, or SPI.
Do not use flashrom on laptops (yet)! The embedded controller (EC) present in
many laptops might interact badly with any attempts to communicate with the
flash chip and may brick your laptop.
Please make a backup of your flash chip before writing to it.
Please see the flashrom(8) manpage :doc:`classic_cli_manpage`.
The list of platforms that package flashrom can be found on `repology.org <https://repology.org/project/flashrom/versions>`_.
Information about recent releases can be found in :doc:`/release_notes/index`.
Building / installing / packaging
---------------------------------
flashrom is built with **meson**. TLDR:
::
meson setup builddir
meson compile -C builddir
meson test -C builddir
meson install -C builddir
For full detailed instructions, follow the information in
:doc:`dev_guide/building_from_source`.
If you are interested in development, have a look at :doc:`dev_guide/development_guide`.
Contact
-------
The official flashrom website is:
https://www.flashrom.org/
For available contact methods see :doc:`contact`