From 7bb7885f6eb19547b906513d2664e3730ef5b593 Mon Sep 17 00:00:00 2001
From: jwijenbergh <jeroenwijenbergh@protonmail.com>
Date: Thu, 5 May 2022 17:47:36 +0200
Subject: Docs: Add API and building improvements

---
 docs/src/gettingstarted/building/example.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 docs/src/gettingstarted/building/example.md

(limited to 'docs/src/gettingstarted/building/example.md')

diff --git a/docs/src/gettingstarted/building/example.md b/docs/src/gettingstarted/building/example.md
new file mode 100644
index 0000000..668d77a
--- /dev/null
+++ b/docs/src/gettingstarted/building/example.md
@@ -0,0 +1,28 @@
+# Example: commands to build for Python
+This section gives an example on how to build and install the library from scratch (assuming you have all the dependencies). It builds the Go library and then builds and installs the Python wrapper.
+
+1. Clone the library
+```bash
+git clone https://github.com/jwijenbergh/eduvpn-common
+```
+
+2. Go to the library directory
+```bash
+cd eduvpn-common
+```
+
+3. Build the go library
+```bash
+make
+```
+
+4. Build the python wrapper
+```bash
+make -C wrappers/python
+```
+
+5. Install the wheel using pip
+```bash
+pip install wrappers/python/dist/eduvpncommon-0.1.0-py3-none-linux_x86_64.whl
+```
+Note that the name of your wheel changes on the platform and version.
-- 
cgit v1.2.3