diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..0a0ea08f7 --- /dev/null +++ b/README.rst @@ -0,0 +1,58 @@ +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`. + + +Building / installing / packaging +--------------------------------- + +flashrom supports building with **make** and **meson**. + +TLDR, building with meson +""""""""""""""""""""""""" + +:: + + meson setup builddir + meson compile -C builddir + meson install -C builddir + +For full detailed instructions, follow the information in +:doc:`dev_guide/building_from_source` + +TLDR, building with make +"""""""""""""""""""""""" + +:: + + make + make install + +For full detailed instructions, follow the information in +:doc:`dev_guide/building_with_make` + +Contact +------- + +The official flashrom website is: + + https://www.flashrom.org/ + +For available contact methods see :doc:`contact` |