aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesús <heckyel@hyperbola.info>2018-02-21 11:33:23 -0500
committerJesús <heckyel@hyperbola.info>2018-02-21 11:33:23 -0500
commit46f2e717244755b5937674325c36ce431de73d50 (patch)
treeb7a38536a358cb8d7c2487365c181682b096d056
parent740985ed6c670d5f59fad4ecb3f63d4e67f0342b (diff)
downloadspectre-meltdown-checker-46f2e717244755b5937674325c36ce431de73d50.tar.lz
spectre-meltdown-checker-46f2e717244755b5937674325c36ce431de73d50.tar.xz
spectre-meltdown-checker-46f2e717244755b5937674325c36ce431de73d50.zip
feat(readme): add quick run section
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index a7b3fc9..61ba3de 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,28 @@ You can also specify a kernel image on the command line, if you'd like to inspec
The script will do its best to detect mitigations, including backported non-vanilla patches, regardless of the advertised kernel version number.
+## Easy way to run the script
+
+- Get the latest version of the script using `curl` *or* `wget`
+
+```bash
+curl -L meltdown.ovh -o spectre-meltdown-checker.sh
+wget meltdown.ovh -O spectre-meltdown-checker.sh
+```
+
+- Inspect the script. You never blindly run scripts you downloaded from the Internet, do you?
+
+```bash
+vim spectre-meltdown-checker.sh
+```
+
+- When you're ready, run the script as root
+
+```bash
+chmod +x spectre-meltdown-checker.sh
+sudo ./spectre-meltdown-checker.sh
+```
+
## Example of script output
- Intel Haswell CPU running under Ubuntu 16.04 LTS