Merge pull request #8 from Spinojara/master

jdart1 · web-flow · commit 6063d5a68b6c · 2024-04-28T06:41:14.000-07:00
Add top level Makefile for compiling a shared object
diff --git a/Makefile b/Makefile
@@ -0,0 +1,33 @@
+MKDIR_P = mkdir -p
+RM      = rm
+INSTALL = install
+
+CC     ?= gcc
+CFLAGS  = -std=gnu99 -O2 -Wall -Wshadow -Isrc
+LDFLAGS = $(CFLAGS)
+
+PREFIX  = /usr/local
+LIBDIR  = $(PREFIX)/lib64
+INCDIR  = $(PREFIX)/include
+
+libfathom.so: obj/tbprobe.o
+	$(CC) $(LDFLAGS) -shared $^ -o $@
+
+obj/tbprobe.o: src/tbprobe.c src/tbchess.c src/stdendian.h src/tbprobe.h
+	@$(MKDIR_P) obj
+	$(CC) $(CFLAGS) -fPIC -c $< -o $@
+
+clean:
+	$(RM) -f libfathom.so
+	$(RM) -rf obj
+
+install: libfathom.so
+	$(MKDIR_P) $(DESTDIR)$(LIBDIR)
+	$(INSTALL) -m 0644 libfathom.so $(DESTDIR)$(LIBDIR)
+	$(INSTALL) -m 0644 src/{stdendian,tbconfig,tbprobe}.h $(DESTDIR)$(INCDIR)
+
+uninstall:
+	$(RM) -f $(DESTDIR)$(LIBDIR)/libfathom.so
+	$(RM) -f $(DESTDIR)$(INCDIR)/{stdendian,tbconfig,tbprobe}.h
+
+.PHONY: clean install uninstall
diff --git a/README.md b/README.md
@@ -12,6 +12,16 @@ are:
 Fathom is compilable under either C99 or C++ and supports a variety of
 platforms, including at least Windows, Linux, and MacOS.
 
+Building the library
+--------------------
+It is possible to build and install Fathom as a shared library on Unix-like
+systems. Simply run the commands
+
+    make
+    make install
+
+in the top level directory.
+
 Tool
 ----
 
