separate index and README

README.rst

@@ -4,8 +4,6 @@ EPBFCat -- an EtherCAT master using EBPF and XDP
 
 EBPFCat is an EtherCAT master written entirely in Python, that uses EPBF and
 XDP to achieve real-time response times. As a corollary, it contains a
-Python based EBPF generator.
+Python based EBPF code generator.
 
-.. toctree::
-    ebpfcat/ethercat.rst
-    ebpfcat/ebpf.rst
+The documentation lives on `readthedocs <https://ebpfcat.readthedocs.io/>`_.

conf.py

@@ -5,7 +5,7 @@ extensions = [
 templates_path = ['_templates']
 numfig = True
 source_suffix = '.rst'
-master_doc = 'README'
+master_doc = 'index'
 
 project = 'EBPFCat'
 copyright = '2020, Martin Teichmann'

ebpfcat/ebpf.rst

@@ -150,8 +150,8 @@ as opposed to just being read. The declaration is like so::
 
    class MyProgram(EBPF):
        array_map = ArrayMap()
-       a_read_variable = array_map("B")  # one byte read-only variable
-       a_write_variable = array_map("i", write=True)  # a read-write integer
+       a_read_var = array_map.globalVar("B")  # one byte read-only variable
+       a_write_var = array_map.globalVar("i", write=True)  # read-write integer
 
 the array map has methods to access the variables:
 

index.rst

+************************************************
+EPBFCat -- an EtherCAT master using EBPF and XDP
+************************************************
+
+EBPFCat is an EtherCAT master written entirely in Python, that uses EPBF and
+XDP to achieve real-time response times. As a corollary, it contains a
+Python based EBPF code generator.
+
+.. toctree::
+    ebpfcat/ebpf.rst
+    ebpfcat/ethercat.rst