Adding steps to build the project (#12)

Author: karreiro

Brewfile.lock.json

@@ -7,6 +7,11 @@
           "rebuild": 0,
           "root_url": "https://ghcr.io/v2/homebrew/core",
           "files": {
+            "arm64_sequoia": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/check/blobs/sha256:11f6f6c67483ebc4a230480a1b068882a8476afc52517d2d68de0ecc24ea305b",
+              "sha256": "11f6f6c67483ebc4a230480a1b068882a8476afc52517d2d68de0ecc24ea305b"
+            },
             "arm64_sonoma": {
               "cellar": ":any",
               "url": "https://ghcr.io/v2/homebrew/core/check/blobs/sha256:62db788052873713c484655c217bb221f71c794df5df63b7a68083df8805f598",
@@ -75,12 +80,12 @@
   "system": {
     "macos": {
       "sonoma": {
-        "HOMEBREW_VERSION": "4.3.2",
-        "HOMEBREW_PREFIX": "/usr/local",
+        "HOMEBREW_VERSION": "4.3.23",
+        "HOMEBREW_PREFIX": "/opt/homebrew",
         "Homebrew/homebrew-core": "api",
-        "CLT": "15.1.0.0.1.1700200546",
-        "Xcode": "15.1",
-        "macOS": "14.2.1"
+        "CLT": "15.3.0.0.1.1708646388",
+        "Xcode": "15.4",
+        "macOS": "14.6.1"
       }
     }
   }

Makefile

@@ -18,8 +18,9 @@ ifeq ($(os),Linux)
 endif
 
 ifeq ($(os),Darwin)
-  test_cflags = $(flags) -I/usr/local/include
-  test_ldflags = -L/usr/local/lib -lcheck -lm
+  brew_prefix := $(shell brew --prefix check)
+  test_cflags = $(flags) -I$(brew_prefix)/include
+  test_ldflags = -L$(brew_prefix)/lib -lcheck -lm
 endif
 
 all: $(exec) test

README.md

@@ -1 +1,54 @@
 # ERBx
+
+Seamless Parsing for HTML, ERB, and more.
+
+## Contributing
+
+This project builds the ERBX program and its associated unit tests using a Makefile for automation. The Makefile provides several useful commands for compiling, running tests, and cleaning the project.
+
+### Requirements
+
+- **GCC**
+- **Check**: The project uses the [Check](https://libcheck.github.io/check/) library for unit testing
+
+For Linux:
+```bash
+sudo apt-get install check
+```
+
+For macOS (using Homebrew):
+```bash
+brew install check
+# or
+brew bundle
+```
+
+### Commands
+
+#### Build
+
+Compiles all source files in `src/` and generates the `erbx` executable.
+
+```bash
+make
+```
+
+#### Test
+
+Builds the test suite from files in `test/` and creates the `run_erbx_tests` executable to run the tests:
+
+```bash
+make test && ./run_erbx_tests
+```
+
+### Clean
+
+Removes the `erbx`, `run_erbx_tests`, and all `.o` files.
+
+```bash
+make clean
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details.