From a939ab016e3f07a40df804ef3217b58427d09949 Mon Sep 17 00:00:00 2001
From: jaseg <git@jaseg.de>
Date: Sun, 6 Feb 2022 23:47:31 +0100
Subject: docs: add quickstart guide

---
 docs/index.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'docs')

diff --git a/docs/index.rst b/docs/index.rst
index f3fb872..07bb084 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -57,6 +57,21 @@ Features
 Quick Start
 ===========
 
+First, install gerbonara from PyPI using pip:
+
+.. highlight:: shell
+
+   pip install --user gerbonara
+
+Then, you are ready to read and write gerber files:
+
+.. highlight:: python
+
+    from gerbonara import LayerStack
+
+    stack = LayerStack.from_directory('output/gerber')
+    w, h = stack.outline.size('mm')
+    print(f'Board size is {w:.1f} mm x {h:.1f} mm')
 
 
 Development
-- 
cgit