aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranciszek Malinka <franciszek.malinka@gmail.com>2022-11-07 21:06:43 +0100
committerFranciszek Malinka <franciszek.malinka@gmail.com>2022-11-08 17:39:32 +0100
commitf70e0f7271a913ec220e31a86b827adee233968f (patch)
treea779f5a4772461cf0e5d849eb10b29370e8f84e8
parent2262c02e374876c35b47b0b24f2af8c6cc611282 (diff)
Updated Authors, little changes to readme.
-rw-r--r--AUTHORS3
-rw-r--r--LICENSE2
-rw-r--r--README.md16
3 files changed, 15 insertions, 6 deletions
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..ed34826
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,3 @@
+Franciszek Malinka
+Kacper Solecki
+Michał Doros
diff --git a/LICENSE b/LICENSE
index 69a9bca..76ff291 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
-Copyright 2022 Franciszek Malinka, Kacper Solecki, Michał Doros
+Copyright 2022 The KomfyDB Authors.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
diff --git a/README.md b/README.md
index 80c9c4b..cb18db4 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,20 @@
Simple database C++ implemenatation based on MIT SimpleDB.
+## Cloning
+
+Run:
+```
+git clone --recursive https://github.com/DorosMichal/KomfyDB
+```
+
## Requierments
- clang-13
- bazel
- openjdk-11-jdk
-On debian-based:
+On Debian Bullseye:
```
sudo apt update && sudo apt install clang-13 bazel openjdk-11-jdk
@@ -37,11 +44,10 @@ bazel clean --expunge
```
## Set up pre-commit
+
+Pre-commit needs to be installed manually:
```
+pip3 install --upgrade pip
pip3 install pre-commit
pre-commit install
```
-If the first one throws an FileNotFoundError try running
-```
-pip3 install --upgrade pip
-```