Add README.md

amezin · Sep 30, 2018 · a70d190 · a70d190
1 parent 15f0e66
commit a70d190
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+Visual Studio Code project for Linux kernel sources
+---------------------------------------------------
+
+Ensure the kernel is built (at least, all *.cmd files should be generated):
+
+    $ make
+
+Clone this repository as ".vscode":
+
+    $ git clone git@github.com:amezin/vscode-linux-kernel.git .vscode
+
+Generate compile_commands.json:
+
+    $ python .vscode/generate_compdb.py
+
+Open the project:
+
+    $ code .