Rename INSTALL.md to BUILDING.md

This commit is contained in:
Tiiffi
2024-12-02 09:42:44 +02:00
parent c0d28bcb17
commit 53fd703911

22
BUILDING.md Normal file
View File

@ -0,0 +1,22 @@
Building and installing
-----------------------
Only dependency is C library and POSIX getopt support.
Compiling with GCC or CLANG:
cc -std=gnu99 -Wpedantic -Wall -Wextra -O2 -o mcrcon mcrcon.c
Note: on Windows remember to link with winsock by adding `-lws2_32` to your compiler command line.
Or you can just run "**make**":
make - compiles mcrcon
make install - installs compiled binaries and manpage to the system
make uninstall - removes binaries and manpage from the system
file install locations:
/usr/local/bin/mcrcon
/usr/local/share/man/man1/mcrcon.1
Makefile "**install**" and "**uninstall**" rules are disabled on windows.