summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbd <bdunahu@operationnull.com>2025-03-01 17:07:27 -0500
committerbd <bdunahu@operationnull.com>2025-03-01 17:07:27 -0500
commit658ffc1ad4beae41262800095c2512005531e84e (patch)
tree4000a321c3a24262770751473994b0aeda8f0b37
parentce10dc7449cabf30e2b56d7d5990af9aa167812d (diff)
update README with dependencies and test information
-rw-r--r--.clang-format6
-rw-r--r--README.md13
2 files changed, 14 insertions, 5 deletions
diff --git a/.clang-format b/.clang-format
index df4a55b..39ed432 100644
--- a/.clang-format
+++ b/.clang-format
@@ -3,7 +3,9 @@ Language: Cpp
AlignAfterOpenBracket: AlwaysBreak
AllowAllParametersOfDeclarationOnNextLine: true
BinPackParameters: false
-BreakBeforeBraces: Allman
+BreakBeforeBraces: Linux
PointerAlignment: Right
ColumnLimit: 80
-IndentWidth: 2 \ No newline at end of file
+IndentWidth: 4
+TabWidth: 4
+UseTab: Always \ No newline at end of file
diff --git a/README.md b/README.md
index 6a8982d..34ae8af 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,19 @@
# Risc V[ECTOR]
+## dependencies
+- cmake
+- g++ (GCC) 11.4.0
+- python 3.10 or newer
+- catch2 version 3.5.3
+
## to compile
Generate the build directory with
+
`cmake -S . -B build`
-then
-`cmake --build build`
-## to test
+then compile both the simulator and tests with
+
+`cmake --build build`
# about