Git Product home page Git Product logo

ultranote's Introduction

Building UltraNote

alt text

On Apple or Linux and can't get readline installed? Run cmake with cmake .. -DFORCE_READLINE=FALSE to disable readline support.

On Linux:

Dependencies: GCC 4.7.3 or later, CMake 2.8.6 or later, GNU Readline, and Boost 1.55 or later.

You may download them from:

Alternatively, it may be possible to install them using a package manager.

To build: Run these commands:

cd ~
sudo apt-get install build-essential git cmake libboost-all-dev libreadline-dev
git clone https://github.com/xun-project/UltraNote.git 
cd UltraNote
mkdir build
cd build
cmake ..
cd ..
make

The resulting executables can be found in UltraNote/build/release/src.

Advanced options:

Parallel build: run make -j<number of threads> instead of make.

Debug build: run make build-debug.

Test suite: run make test-release to run tests in addition to building. Running make test-debug will do the same to the debug version.

Building with Clang: it may be possible to use Clang instead of GCC, but this may not work everywhere. To build, run export CC=clang CXX=clang++ before running make.

On Windows

Prerequisites
  • Install Visual Studio 2017 Community Edition
  • When installing Visual Studio, it is required that you install Desktop development with C++ and the VC++ v140 toolchain when selecting features. The option to install the v140 toolchain can be found by expanding the "Desktop development with C++" node on the right. You will need this for the project to build correctly.
  • Install Boost 1.59.0, ensuring you download the installer for MSVC 14.
Building
  • From the start menu, open 'x64 Native Tools Command Prompt for vs2017'.
  • cd <your_ultranote_directory>
  • mkdir build
  • cd build
  • Set the PATH variable for cmake: ie. set PATH="C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin";%PATH%
  • cmake -G "Visual Studio 15 2017 Win64" .. -DBOOST_ROOT=C:/local/boost_1_59_0 (Or your boost installed dir.)
  • MSBuild UltraNote.sln /p:Configuration=Release /m
  • If all went well, it will complete successfully, and you will find all your binaries in the '..\build\src\Release' directory.
  • Additionally, a .sln file will have been created in the build directory. If you wish to open the project in Visual Studio with this, you can.

On Apple:

brew install git cmake boost rocksdb readline
brew link --force readline
git clone https://github.com/xun-project/UltraNote.git
cd UltraNote
mkdir build
cd build
cmake ..
make

The resulting executables can be found in UltraNote/build/release/src.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.