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

Add OS X build instructions.

Kishore Nallan2804b145dd37
diff --git a/.gitignore b/.gitignore
index a14afefc..0d590c5b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
.idea
*.iml
external
+build
\ No newline at end of file
diff --git a/.gitmodules b/.gitmodules
index b9d0b9a4..216c807c 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,8 +1,4 @@
[submodule "external/for"]
path = external/for
url = [email protected]:cruppstahl/for.git
- ignore = dirty
-[submodule "external/crow"]
- path = external/crow
- url = [email protected]:ipkn/crow.git
ignore = dirty
\ No newline at end of file
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 3c9c4ba1..b0137695 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1,8 +1,8 @@
cmake_minimum_required(VERSION 2.8)
project(search)
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -stdlib=libc++ -std=gnu++11 -O2")
-set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -std=c++11 -stdlib=libc++ -std=gnu++11 -O0")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -O2")
+set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -std=c++11 -O0")
# FIXME: Need to use find_package() to locate the correct openssl library
# FIXME: build libfor as part of the build process
diff --git a/README.md b/README.md
index 2efbe7ae..70be17a7 100644
--- a/README.md
+++ b/README.md
@@ -13,12 +13,34 @@ TODO
## Dependencies
+* [RocksDB](https://github.com/facebook/rocksdb)
* [libfor](https://github.com/cruppstahl/for/)
* [h2o](https://github.com/h2o/h2o)
-* OpenSSL
-## Building `libfor`
+## Building Typesense from source
-* Switch to `external/libfor` and build libfor
+### OS X
-© 2016 Wreally Studios Inc.
\ No newline at end of file
+Homebrew dependencies:
+
+```
+brew install cmake
+brew install openssl
+brew install h2o
+brew install rocksdb
+```
+
+Building libfor:
+
+```
+cd external/libfor
+make
+```
+
+Finally, building Typsense:
+
+```
+./build.sh
+```
+
+© 2016-2017 Wreally Studios Inc.
\ No newline at end of file
diff --git a/build.sh b/build.sh
new file mode 100755
index 00000000..2d70df2b
--- /dev/null
+++ b/build.sh
@@ -0,0 +1,6 @@
+#!/bin/sh
+PROJECT_DIR=`dirname $0`
+rm -rf $PROJECT_DIR/build
+mkdir $PROJECT_DIR/build
+cmake -H$PROJECT_DIR -B$PROJECT_DIR/build
+make -C $PROJECT_DIR
\ No newline at end of file