From 2200ed1c24199d16bdf2a8b05f72e3f4e7f02be1 Mon Sep 17 00:00:00 2001
From: "hieda_kyuko@hpr" <ugo58956@protonmail.com>
Date: Mon, 28 Apr 2025 11:16:42 +0200
Subject: [PATCH] Update readme

---
 README.org | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.org b/README.org
index f8a6d20..8cc86b4 100644
--- a/README.org
+++ b/README.org
@@ -6,4 +6,24 @@
 * Usage
 For the time being, the suite only has a single utility, =oud2_parser.pl=. Please note that this does not return anything yet and simply prints the result of the parse to the standard output.
 
-Support for processing user-provided files will soon be added.
+Sample diagram files are provided in the ~tests/dia~ directory.
+
+** =oud2_parser.pl=
+
+Parse a single diagram file.
+
+#+begin_src bash
+  oud2_parser.pl
+  oud2_parser.pl <filename>.oud2
+#+end_src
+
+For now, if no file is provided, a default diagram file is used instead.
+
+
+* Licensing
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
-- 
GitLab