summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.clang-format11
-rw-r--r--.gitignore2
-rw-r--r--CMakeLists.txt2
-rw-r--r--README.md13
4 files changed, 24 insertions, 4 deletions
diff --git a/.clang-format b/.clang-format
new file mode 100644
index 0000000..39ed432
--- /dev/null
+++ b/.clang-format
@@ -0,0 +1,11 @@
+---
+Language: Cpp
+AlignAfterOpenBracket: AlwaysBreak
+AllowAllParametersOfDeclarationOnNextLine: true
+BinPackParameters: false
+BreakBeforeBraces: Linux
+PointerAlignment: Right
+ColumnLimit: 80
+IndentWidth: 4
+TabWidth: 4
+UseTab: Always \ No newline at end of file
diff --git a/.gitignore b/.gitignore
index e788ced..c8346bd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,8 @@
# IDE
/.dir-locals.el
/manifest.scm
+/.ccls-cache
+/compile_commands.json
# generated
__pycache__
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 2029ba0..e36b290 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1,7 +1,7 @@
cmake_minimum_required(VERSION 3.5)
project(risc_vector)
-#set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
# cpp standard
set(CMAKE_CXX_STANDARD 17)
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