From 5721662ea4802457c9a31d0a842c91d74ffeb044 Mon Sep 17 00:00:00 2001
From: Ivar Matstoms <ivma@lysator.liu.se>
Date: Tue, 18 Feb 2025 08:19:49 +0100
Subject: [PATCH] Update docs and readme.md

---
 docs/source/index.md             |  1 +
 docs/source/pages/development.md |  6 ++++++
 docs/source/pages/protocol.md    |  1 +
 docs/source/pages/utils.md       |  8 ++++++++
 pyskom/utils/__init__.py         |  2 +-
 readme.md                        | 10 +++++-----
 6 files changed, 22 insertions(+), 6 deletions(-)
 create mode 100644 docs/source/pages/utils.md

diff --git a/docs/source/index.md b/docs/source/index.md
index 2b985ee..796ad82 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -6,6 +6,7 @@
 pages/quick-start
 pages/protocol
 pages/client
+pages/utils
 pages/development
 ```
 
diff --git a/docs/source/pages/development.md b/docs/source/pages/development.md
index 68e2932..585c0a0 100644
--- a/docs/source/pages/development.md
+++ b/docs/source/pages/development.md
@@ -20,3 +20,9 @@ Generate errors
 ```bash
 python -m tools.codegen errors errors.json
 ```
+
+## Running tests
+To run tests, make sure that `pytest` is installed and simply run:
+```bash
+pytest
+```
\ No newline at end of file
diff --git a/docs/source/pages/protocol.md b/docs/source/pages/protocol.md
index 7909703..98ec3db 100644
--- a/docs/source/pages/protocol.md
+++ b/docs/source/pages/protocol.md
@@ -1,4 +1,5 @@
 # Protocol
+The protocol module subpackage implements LysKOM types as well as a parser and writer for encoding/decoding.
 ## Base
 ```{eval-rst}  
 .. automodule:: pyskom.protocol.base
diff --git a/docs/source/pages/utils.md b/docs/source/pages/utils.md
new file mode 100644
index 0000000..16ec7b8
--- /dev/null
+++ b/docs/source/pages/utils.md
@@ -0,0 +1,8 @@
+# Utils
+## Text-no utils
+```{eval-rst}  
+.. automodule:: pyskom.utils.text_no
+    :members:
+    :undoc-members:
+    
+```
diff --git a/pyskom/utils/__init__.py b/pyskom/utils/__init__.py
index a52ebf1..75254ae 100644
--- a/pyskom/utils/__init__.py
+++ b/pyskom/utils/__init__.py
@@ -1 +1 @@
-from .text_no import read_to_unread
\ No newline at end of file
+from .text_no import read_to_unread, text_block_to_list
\ No newline at end of file
diff --git a/readme.md b/readme.md
index 9410332..2a54471 100644
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,5 @@
-# TODO
-* Types
-  * Arrays
-  * ...
-* Protocol A writer
\ No newline at end of file
+# PysKOM
+Pyskom is a LysKOM library written in Python.
+
+## Documentation
+[https://www.lysator.liu.se/~ivma/pyskom/docs/index.html](https://www.lysator.liu.se/~ivma/pyskom/docs/index.html)
\ No newline at end of file
-- 
GitLab