Skip to content

cm0x4D/libdocset

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fast and simple to use C++ library to handle docset bundles.

Scan a folder for docsets:

DocsetGroup myDocsets = DocsetGroup::open("/home/me/Docsets", true);

And you already can start searching in the docsets:

DocsetObjectList obs = myDocsets.find("std::cout");
for (auto o: obs)
    std::cout << o.name() << "\n";

Currently the library runs on Linux and OS X.

How do I get set up?

You need a C++11 compliant compiler (GCC, clang), cmake, make or ninja and the SQLite3 library and headers in order to build the library.

  • Clone or Download the code:
git clone https://github.com/cm0x4D/libdocset.git
cd libdocset
wget https://github.com/cm0x4D/libdocset/archive/master.zip
unzip libdocset-master.zip
cd libdocset-master
  • Build the library using cmake and make:
mkdir build
cd build
cmake -D CMAKE_BUILD_TYPE=Release ..
make

... or with ninja:

mkdir build
cd build
cmake -G Ninja -D CMAKE_BUILD_TYPE=Release ..
ninja
  • (Optional) Install the library:
sudo make install

or

sudo ninja install

Contact

If you have questions or sugestion, do not hesitate to contact me cm0x4d@codemonkey.ch

About

Fast and simple to use C++ library to handle docset bundles.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published