Installation

The Cxxomfort library is distributed as "header-only", meaning it is not necessary to compile object code or link to libraries to use it[#1]. All that is necessary is essentially:

  1. Download package or pull the repo…
  2. Extract / open it somewhere…
  3. Proceed with the Configuration
  4. Use!
  5. Issue a "fossil update" if you want to stay tuned.

For example, under Linux you can install the library by uncompressing it into a directory and then just moving the library's cxxomfort directory under /usr/local/include - or creating a symlink to it - and it should work out of the box without the need to add any search path, since /usr/local/include is a "standard search path".

After you are done installing the library, you might want to check how to configure it and how to use it.

Tested Environments

Development is currently (2018) held in the following testbeds:

  • Debian Jessie + GCC 4.8/4.9 (main)
  • Debian Buster + GCC 6
  • Windows XP + MSVC 2008 Express / 2010 Express
  • Ubuntu Precise + GCC 4.6 environment.

Methods of Installation

Clone the repo!:

Simply create a directory somewhere and run Fossil (external link) on it:

fossil clone http://ryan.gulix.cl/fossil.cgi/cxxomfort cxxomfort.fossil

Then open the cloned repository.

fossil open cxxomfort cxxomfort.fossil

Alternatively, you can browse "Files" in the upper navigation bar to get a tarball of the current contents of the repo.

For the library to be visible to your compiler / project, just add the path to its child "cxxomfort" folder to your compiler / project's search paths.

Staying Updated

In order to stay updated all that is necessary is to clean your local copy's working directory, then issue fossil's own command to update:

fossil clean
fossil update

For users updating from 0.45 or below: You will need to perform a fossil clean -x before updating, and then you'll need to repoint your compiler's search path to the new cxxomfort directory, as of 0.51 onwards the file structure has changed. In case of doubts, you can also fossil close, delete the clone directory and repo and then download from scratch as well.

Downloading the Documentation

To be included: a zip file with the documentation from this site.


1 Which is why it does not include a "Makefile", though adding one will be done eventually.

Proceed with the Configuration