Oberon /

Filename Size Date modified Message
examples
oberon
29 B
329 B
554 B
2.8 KB
1.2 KB

README

Oberon - A Subcommand Program Options Library

Subcommands are an effective way of making a complex command line application easier to use. The essential idea is that the high level capabilities of the application are separated, each having their own distinct options and focussed purpose. Once an application reaches a certain amount of complexity it becomes exceedingly difficult to use without this separation. Probably the most well known application to utilise this technique is Subversion (svn).

Oberon is built on top of Boost.Program_options, is available under the permissive Apache 2.0 license and is written in modern C++. I named it Oberon after a type of submarine.

Version

0.7.2

  • Adjustment to ExceptionTranslater to correctly return boost::none for a boost::optional instead of nullptr, required for boost 1.58 compatibility. Thanks to mwijngaard.

0.7.1

  • Fix for utility method to do with unlimited positional option parsing. Thanks to mwijngaard.

0.7.0

  • First released version

How to build?

Building of Oberon should be straightforward as it has only 1 external dependency and there are no complicated configuration steps. In order to build you will need to have a copy of boost and I would recommend 1.55.0 or 1.56.0, although I would expect it to work with others too.

Generally when integrating a library into a project you already have a build tool that is being leveraged; make, cmake, premake, VisualStudio etc. If you are in this position then all you need to do is add the Oberon source code to your project and link and include the boost libraries through the mechanisms your build system provides. With this said I have included Premake build files for easy building of the example code. To use it you will need to download it. Please see the wiki for more detailed information.

Contribution guidelines

Participation in the development of Oberon is encouraged and appreciated. The source code repository is curated by Conrad "radman" Mercer and additions will be reviewed before they appear in the public version of the code. Once other knowledgeable contributors are established this workload will be shared and the responsibility distributed.

Who do I talk to?

There are a few sources of information available for Oberon: