Initial commit

1 files changed, 16 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..071d2e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# A tiny demo for a Python module in C
+
+This repo contains a Python module written in C with only one function.
+
+Works on my machine™. To make it works on yours:
+
+1. Install the python development package. It is usually called `python3-dev`
+   or `python3-devel`.
+2. Compile this module with `make`.
+3. Open `python` and enjoy!
+
+```
+>>> import sum_module
+>>> sum_module.sum_from_c(23, 19)
+42
+```