diff --git a/README.org b/README.org index f8a6d204c8e27eb77b91759cd7f15cb04c9c58dc..8cc86b4b5fa2825d1f92cb0faa63627fb9c211d7 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/>.