mirror of
https://github.com/falk-werner/webfuse
synced 2026-10-29 08:08:59 +00:00
add project documentation
This commit is contained in:
35
doc/build.md
Normal file
35
doc/build.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# webfuse build instructions
|
||||
|
||||
## Build
|
||||
|
||||
````
|
||||
cmake -B build
|
||||
cmake --build build
|
||||
sudo cmake --install build
|
||||
````
|
||||
|
||||
## Build options
|
||||
|
||||
| Options | Default | Description |
|
||||
| ------------------ | -------- | ----------- |
|
||||
| WITHOUT_PROVIDER | OFF | Disables build of webfuse provider |
|
||||
| WITHOUT_TEST | OFF | Disables build of unit and integration tests |
|
||||
| WITHOUT_CLANG_TIDY | OFF | Disables running clang tidy on build |
|
||||
|
||||
## Dependencies
|
||||
|
||||
- [libfuse](https://github.com/libfuse/libfuse)
|
||||
- [libwebsockets](https://libwebsockets.org/)
|
||||
|
||||
### Optional dependencies
|
||||
|
||||
- [googletest](https://github.com/google/googletest)
|
||||
- [valgrind](https://valgrind.org/)
|
||||
- [clang-tidy](https://clang.llvm.org/extra/clang-tidy/)
|
||||
|
||||
## Additional cmake targets
|
||||
|
||||
| Target | Description |
|
||||
| -------- | ----------- |
|
||||
| test | runs unit and integration tests |
|
||||
| memcheck | runs unit test with valgrind/memcheck |
|
||||
Reference in New Issue
Block a user