From 75b29d9cda09a1198e1a01b0f98b6620c743c556 Mon Sep 17 00:00:00 2001 From: Ekaitz Zarraga Date: Mon, 25 Mar 2024 17:41:50 +0100 Subject: doc: document the project --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bdae113..7089470 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ # Guile Neocities -Guile library for and command line tool for [Neocities -API](https://neocities.org/api). +Guile API and command line tool for [Neocities API](https://neocities.org/api). + +If you wish to read some documentation, the `doc` folder should cover your +needs. If you want to read it in a better format, you can use `texinfo` to +convert it to Info, PDF or HTML. + +If you want to play around with the command line tool, install it using the +documentation and just run `neocities --help` to learn how to use it. + +If you are interested on the Guile API, you should take a look to the docs, and +use `neocities/cli.scm` as a source of simple and useful examples. -- cgit v1.2.3