diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..1997d44 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,49 @@ +# Build Instructions + +This project requires a C compiler to build native dependencies. + +## Linux (Debian/Ubuntu) + +```bash +sudo apt-get update +sudo apt-get install -y build-essential +``` + +## macOS + +```bash +xcode-select --install +``` + +## Windows + +Install Visual Studio Build Tools. + +## Building + +```bash +# Navigate to project directory +cd techdebt-tracker-cli + +# Build the project +cargo build --release + +# Run tests +cargo test + +# Run linting +cargo clippy +``` + +## Dependencies Installed + +The project uses the following key dependencies: +- clap 4.4 - CLI argument parsing +- ratatui 0.26 - Terminal UI framework +- tree-sitter 0.22 - Source code parsing +- serde 1.0 - Serialization +- regex 1.10 - Pattern matching +- anyhow 1.0 - Error handling +- ignore 0.4 - File traversal with gitignore support +- crossterm 0.28 - Terminal capabilities +- chrono 0.4 - Date/time handling