Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add tutorial and user doc. #4

Merged
merged 14 commits into from Aug 10, 2021
Merged

Add tutorial and user doc. #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d9f7dbd
Add doc
ZiyanShi Aug 6, 2021
4537328
add tutorial
ZiyanShi Aug 9, 2021
2c08697
Hide incomplete docs.
ZiyanShi Aug 9, 2021
5999521
hide images for impl doc
ZiyanShi Aug 9, 2021
d703d90
Merge branch 'main' of https://github.com/pmem/kvdk into main
peifengsi Aug 9, 2021
6d68a3b
update tutorial
peifengsi Aug 9, 2021
2150a10
revise user_doc.md
ZiyanShi Aug 9, 2021
6e78982
Switch to LLVM style...
peifengsi Aug 9, 2021
5431780
Merge branch 'main' of https://github.com/ZiyanShi/kvdk into main
peifengsi Aug 9, 2021
48e81f7
Change code snippets to LLVM style.
ZiyanShi Aug 9, 2021
039566d
Merge branch 'pmem:main' into main
ZiyanShi Aug 9, 2021
f655412
modify names
ZiyanShi Aug 10, 2021
e0d2696
modify typesetting
ZiyanShi Aug 10, 2021
5cd8a25
trivial modify
ZiyanShi Aug 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions .gitignore
View file
Open in desktop
@@ -1,3 +1,11 @@
build/
.idea/
cmake-build-*
.vscode/
/.vs
/doc/impl_doc_cn.md
/doc/impl_doc.md
/doc/images
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why ignore these?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

impl_doc is incomplete yet. /.vs contains irrelevant Visual Studio Intellisense files.

# Prerequisites
*.d

Expand Down
7 changes: 7 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Expand Up @@ -46,4 +46,11 @@ if (BUILD_TESTING)
add_subdirectory(extern/gtest)
add_executable(dbtest ${TEST_SOURCES})
target_link_libraries(dbtest PUBLIC engine gtest gmock gtest_main)
endif ()

option(BUILD_TUTORIAL "Build the tutorial" ON)
if (BUILD_TUTORIAL)
set(TUTORIAL_SOURCES examples/tutorial.cpp)
add_executable(dbtutorial ${TUTORIAL_SOURCES})
target_link_libraries(dbtutorial PUBLIC engine)
endif ()