sync

Author: gcsmith

Makefile

@@ -91,14 +91,16 @@ C_O_FILES := $(foreach file,$(C_FILES:.c=.o),$(BUILD_DIR)/$(file))
 
 O_FILES := $(C_O_FILES) $(S_O_FILES) $(B_O_FILES)
 
+DEP_FILES := $(C_O_FILES:.o=.d)
+
 CRC := $(TOOLS_DIR)/n64crc
 
 OPT_FLAGS      = -O2
 LOOP_UNROLL    =
 
 MIPSISET       = -mips2 -32
 
-INCLUDE_CFLAGS = -I. -Iinclude -Isrc -I$(TOOLS_DIR)/ultralib/include
+INCLUDE_CFLAGS = -I. -Iinclude -Isrc -I$(TOOLS_DIR)/ultralib/include/compiler/ido -I$(TOOLS_DIR)/ultralib/include
 
 ASFLAGS        = -EB -mtune=vr4300 -march=vr4300 -mabi=32 -I include
 OBJCOPYFLAGS   = -O binary
@@ -118,7 +120,7 @@ CFLAGS += $(DEFINES)
 CFLAGS += -woff 624,649,838,712,516,513,596,564,594,709,807
 CFLAGS += $(INCLUDE_CFLAGS)
 
-CHECK_WARNINGS := -Wall -Wextra -Wno-format-security -Wno-unknown-pragmas -Wunused-function -Wno-unused-parameter -Wno-unused-variable -Wno-missing-braces -Wno-int-conversion
+CHECK_WARNINGS := -Wall -Wextra -Wno-format-security -Wno-unknown-pragmas -Wunused-function -Wno-unused-parameter -Wno-unused-variable -Wno-missing-braces -Wno-int-conversion -Wno-multichar
 CC_CHECK := $(GCC_HOST) -fsyntax-only -fno-builtin -fsigned-char -std=gnu90 -m32 $(CHECK_WARNINGS) $(INCLUDE_CFLAGS) $(DEFINES)
 
 LD_FLAGS := -T $(LD_SCRIPT)
@@ -200,7 +202,7 @@ $(ROM_ELF): $(LD_SCRIPT) $(BUILD_DIR)/$(LIBULTRA) $(O_FILES) $(LANG_RNC_O_FILES)
 ifndef PERMUTER
 $(GLOBAL_ASM_O_FILES): $(BUILD_DIR)/%.o: %.c
 	@printf "[$(YELLOW) syntax $(NO_COL)]  $<\n"
-	$(V)$(CC_CHECK) $<
+	$(V)$(CC_CHECK) -MMD -MP -MT $@ -MF $(BUILD_DIR)/$*.d $<
 	@printf "[$(GREEN) ido5.3 $(NO_COL)]  $<\n"
 	$(V)$(ASM_PROCESSOR) $(OPT_FLAGS) $< > $(BUILD_DIR)/$<
 	$(V)$(CC) -c $(CFLAGS) $(OPT_FLAGS) $(LOOP_UNROLL) $(MIPSISET) -o $@ $(BUILD_DIR)/$<
@@ -211,7 +213,7 @@ endif
 # non asm-processor recipe
 $(BUILD_DIR)/%.o: %.c
 	@printf "[$(YELLOW) syntax $(NO_COL)]  $<\n"
-	$(V)$(CC_CHECK) $<
+	$(V)$(CC_CHECK) -MMD -MP -MT $@ -MF $(BUILD_DIR)/$*.d $<
 	@printf "[$(GREEN) ido5.3 $(NO_COL)]  $<\n"
 	$(V)$(CC) -c $(CFLAGS) $(OPT_FLAGS) $(LOOP_UNROLL) $(MIPSISET) -o $@ $<
 
@@ -245,6 +247,9 @@ $(SPLAT):
 	@which git >/dev/null
 	git submodule update --init --recursive
 
+# include compiler generated dependency files
+-include $(DEP_FILES)
+
 ### Settings
 .SECONDARY:
 .PHONY: all clean default dirs expected verify no_verify

README.md

@@ -7,3 +7,45 @@ The purpose of this project is to produce a reconstruction of the high-level sou
 > [!IMPORTANT]
 > This repository does not contain any game assets, assembly code, or other copyrighted materials.
 > You must provide your own legally-obtained copy of the game in order to extract the assets necessary to build this repository.
+
+## Development
+
+### Git
+This repository uses Git submodules. Make sure to either clone the repository with the `--recurse-submodules` flag or to run `git submodule update --init --recursive` after the initial clone.
+
+When pulling updates, you can update all submodules with `git submodule update --recursive`.
+
+> Note: If you intend on developing inside of the Windows Subsystem for Linux (WSL), consider placing the repository on the WSL Linux partition. Builds are considerably slower when done on the Windows partition through WSL.
+
+### Prerequisites
+
+#### System packages
+
+##### Linux / Windows Subsystem for Linux
+The following packages should be all you need to compile this project:
+- binutils-mips-linux-gnu
+- gcc
+- git
+- python3
+- python3-pip
+
+#### Python3 packages / venv
+
+```bash
+python3 -m venv .venv
+source ./.venv/bin/activate
+python3 -m pip install -r requirements.txt
+```
+
+### Setup
+1. Place an unmodified Superman 64 ROM into the root of the repository as `baserom.us.z64` (SHA1SUM: `c271db752610c9581e1ba1e9125ea8ecdb56f74f`).
+2. Set up dependencies
+    - `make dependencies`
+3. Init project
+    - `make init`
+
+### Rebuilding
+1. If any symbols or the splat config were changed, re-extract the ROM and rebuild the linker script:
+    - `make extract`
+2. Rebuild the ROM:
+    - `make -j`