aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 25 insertions, 7 deletions
diff --git a/README b/README
index 4e7bd4fb..d00524e6 100644
--- a/README
+++ b/README
@@ -39,14 +39,30 @@ page.
it with bzip2.
The snapshot tarballs are the result of 'make tarball' and require no
-further processing.
+further processing. Some git files (for example the rust bindings) are omitted
+from the tarball, as controlled by the .gitattributes files.
Build Instructions
------------------
+flashrom supports building with make and meson.
+
+Meson build system supports almost all the environments, although not exactly
+all of them. Full meson support is on the roadmap in the nearest future.
+To build flashrom with meson, follow the instruction and information in
+/Documentation/building.md
+
+If you are unsure which build system to use, and/or don't know what's the
+difference, use make for now.
+
+The rest of Build Instructions below refers to building flashrom with make.
+
To build flashrom you need to install the following software:
+ * C compiler (GCC / clang)
+ * pkg-config
+
* pciutils+libpci (if you want support for mainboard or PCI device flashing)
* libusb (if you want FT2232, Dediprog or USB-Blaster support)
* libftdi (if you want FT2232 or USB-Blaster support)
@@ -161,6 +177,12 @@ If you are using clang and if you want to enable only one driver, you may hit an
overzealous compiler warning from clang. Compile with "make WARNERROR=no" to
force it to continue and enjoy.
+Bindings:
+
+ Foreign function interface bindings for the rust language are included in the
+ bindings folder. These are not compiled as part of the normal build process.
+ See the readme under bindings/rust for more information.
+
Installation
------------
@@ -183,10 +205,6 @@ The official flashrom website is:
http://www.flashrom.org/
-The IRC channel is
-
- #flashrom at irc.freenode.net
-
-The mailing list address is
+Available contact methods are
- flashrom@flashrom.org
+ https://www.flashrom.org/Contact