changeset 69:158364bdebc4

misc: add INSTALL.md
author David Demelier <markand@malikania.fr>
date Sat, 20 Aug 2022 12:11:44 +0200
parents 88f6f368e9e8
children c84312e15b77
files .hgignore INSTALL.md
diffstat 2 files changed, 30 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/.hgignore	Sat Aug 20 10:56:40 2022 +0200
+++ b/.hgignore	Sat Aug 20 12:11:44 2022 +0200
@@ -29,3 +29,6 @@
 
 # documentation.
 ^doc/html
+
+# Distribution files.
+^sci-\d\.\d.\d\.tar\.xz(\.asc)?$
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL.md	Sat Aug 20 12:11:44 2022 +0200
@@ -0,0 +1,27 @@
+sci INSTALL
+===========
+
+Installation instructions.
+
+Requirements
+------------
+
+- [curl][], required to perform HTTP requests,
+- [kcgi][], minimal CGI/FastCGI library for C,
+- [sqlite][], most used database in the world,
+- [jansson][], JSON library in C.
+
+Basic installation
+------------------
+
+Quick install.
+
+	$ tar xvzf sci-x.y.z-tar.xz
+	$ cd sci-x.y.z
+	$ make
+	# sudo make install
+
+[curl]: https://curl.haxx.se
+[jansson]: https://github.com/akheron/jansson
+[kcgi]: https://kristaps.bsd.lv/kcgi
+[sqlite]: https://www.sqlite.org