Skip to content

Open Source alternative to Algolia + Pinecone and an Easier-to-Use alternative to ElasticSearch ⚡ 🔍 ✨ Fast, typo tolerant, in-memory fuzzy Search Engine for building delightful search experiences

Fix libfor repository URL - updated CMakeLists & README.

Kishore Nallan59f25dca39fe
diff --git a/.gitmodules b/.gitmodules
index 216c807c..911f1f5c 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,4 +1,4 @@
-[submodule "external/for"]
- path = external/for
- url = [email protected]:cruppstahl/for.git
+[submodule "external/libfor"]
+ path = external/libfor
+ url = [email protected]:cruppstahl/libfor.git
ignore = dirty
\ No newline at end of file
diff --git a/CMakeLists.txt b/CMakeLists.txt
index cca77389..73892eec 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -8,11 +8,11 @@ set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -std=c++11 -O0")
# FIXME: build libfor as part of the build process
include_directories(include)
-include_directories(external/for)
+include_directories(external/libfor)
include_directories(/usr/local/opt/openssl/include)
add_executable(search src/art.cpp src/intersection.cpp src/main.cpp src/collection.cpp)
add_executable(typesense-server src/art.cpp src/intersection.cpp src/collection.cpp src/server.cpp)
-target_link_libraries(search ${CMAKE_SOURCE_DIR}/external/for/libfor.a rocksdb)
-target_link_libraries(typesense-server ${CMAKE_SOURCE_DIR}/external/for/libfor.a curl h2o-evloop pthread /usr/local/opt/openssl/lib/libssl.a /usr/local/opt/openssl/lib/libcrypto.a rocksdb)
\ No newline at end of file
+target_link_libraries(search ${CMAKE_SOURCE_DIR}/external/libfor/libfor.a rocksdb)
+target_link_libraries(typesense-server ${CMAKE_SOURCE_DIR}/external/libfor/libfor.a curl h2o-evloop pthread /usr/local/opt/openssl/lib/libssl.a /usr/local/opt/openssl/lib/libcrypto.a rocksdb)
\ No newline at end of file
diff --git a/README.md b/README.md
index 70be17a7..dc33f90c 100644
--- a/README.md
+++ b/README.md
@@ -5,23 +5,21 @@ Typesense is an open source search engine for building a delightful search exper
- **Typo tolerance:** Handles typographical errors out-of-the-box
- **Tunable ranking + relevancy:** Tailor your search results to perfection
- **Blazing fast:** Meticulously designed and optimized for speed
-- **Simple and delightful:** Dead simple API, delightful out-of-the-box experience
-
-## Quick start
-
-TODO
+- **Simple and delightful:** Simple API, delightful out-of-the-box experience
## Dependencies
* [RocksDB](https://github.com/facebook/rocksdb)
-* [libfor](https://github.com/cruppstahl/for/)
+* [libfor](https://github.com/cruppstahl/libfor/)
* [h2o](https://github.com/h2o/h2o)
## Building Typesense from source
+First, clone the git repository with `--recursive` option.
+
### OS X
-Homebrew dependencies:
+Install the following Homebrew dependencies:
```
brew install cmake
@@ -33,11 +31,10 @@ brew install rocksdb
Building libfor:
```
-cd external/libfor
-make
+make -C external/libfor
```
-Finally, building Typsense:
+Finally, build Typesense:
```
./build.sh
diff --git a/external/for b/external/for
deleted file mode 160000
index 49611808..00000000
--- a/external/for
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit 49611808d08d4e47116aa2a3ddcabeb418f405f7