diff --git a/C-client-notes.md b/C-client-notes.md index 90782af0f..30385d02c 100644 --- a/C-client-notes.md +++ b/C-client-notes.md @@ -1,24 +1,3 @@ -### Compiling on linux - -Install appropriate libs as required. Build steps are still WIP, but current way I'm using is: - -Compiling for linux: - -```gcc *.c -o ClassiCube -lX11 -lpthread -lGL -lm -lcurl -lopenal -ldl``` - -Cross compiling for windows: - -```i586-mingw32msvc-gcc *.c -o ClassiCube.exe -mwindows -lws2_32 -lwininet -lwinmm -limagehlp -lcrypt32 -ld3d9``` - -Explicitly: - -```i586-mingw32msvc-gcc *.c -DCC_BUILD_MANUAL -DCC_BUILD_WIN -DCC_BUILD_D3D9 -o ClassiCube.exe -mwindows -lws2_32 -lwininet -lwinmm -limagehlp -lcrypt32 -ld3d9``` - -```i586-mingw32msvc-gcc *.c -DCC_BUILD_MANUAL -DCC_BUILD_WIN -o ClassiCube.exe -mwindows -lws2_32 -lwininet -lwinmm -limagehlp -lcrypt32 -lopengl32``` - - -For ubuntu, this means you probably need to install: libx11-dev, libgl1-mesa-dev, libopenal-dev, libcurl4-gnutls-dev or libcurl4-openssl-dev - ### Platform Although the majority of the code is designed to be platform-independent, some per-platform functionality is required. diff --git a/readme.md b/readme.md index 06bd32fab..924d1a388 100644 --- a/readme.md +++ b/readme.md @@ -46,3 +46,27 @@ Run ClassiCube.exe. You can connect to LAN/locally hosted servers, ~~minecraft.n * If the server has disabled hacks, key combinations such as fly and speed will not do anything. * To see the list of built in commands, type `/client`. * To see help for a given built in command, type `/client help `. + +### Compiling on linux + +Install appropriate libs as required. For ubuntu this means: libx11-dev, libgl1-mesa-dev, libopenal-dev, libcurl4-gnutls-dev or libcurl4-openssl-dev + +Compiling for linux: + +```gcc *.c -o ClassiCube -lX11 -lpthread -lGL -lm -lcurl -lopenal -ldl``` + +Cross compiling for windows: + +```i586-mingw32msvc-gcc *.c -o ClassiCube.exe -mwindows -lws2_32 -lwininet -lwinmm -limagehlp -lcrypt32 -ld3d9``` + +Explicitly: + +```i586-mingw32msvc-gcc *.c -DCC_BUILD_MANUAL -DCC_BUILD_WIN -DCC_BUILD_D3D9 -o ClassiCube.exe -mwindows -lws2_32 -lwininet -lwinmm -limagehlp -lcrypt32 -ld3d9``` + +```i586-mingw32msvc-gcc *.c -DCC_BUILD_MANUAL -DCC_BUILD_WIN -o ClassiCube.exe -mwindows -lws2_32 -lwininet -lwinmm -limagehlp -lcrypt32 -lopengl32``` + +### Documentation + +Functions and variables in .h files are mostly documented. + +General information (e.g. portablity) for the game's source code can be found in the misc folder. \ No newline at end of file