Giter Club home page Giter Club logo

subspace's Introduction

CI hdoc sub-doc

Subspace Library

An experimental take on a safer, simpler C++ standard library.

Please don't use this library. This is an experiment and we don't yet know where it will take us. There will be breaking changes without warning, and there is no stable version.

  1. See BUILD.md for instructions on building Subspace and Subdoc and running their tests.
  2. See USAGE.md for instructions on integrating the Subspace library into your project.
  3. See PRINCIPLES.md for the principles behind design choices in the Subspace library.
  4. See STYLE.md for evolving guidance and best practices for developers of the Subspace library.

Subdoc

Subdoc is a documentation generator from inline C++ documentation in the spirit of Rustdoc.

The comments in the Subspace library use markdown syntax with additional Subdoc attributes, and are designed to be consumed by Subdoc in order to generate an HTML website.

Subdoc is built on top of Subspace, giving the developers a chance to see the Subspace library in action and test the ergonomics and features of the library.

Status: Subdoc is still very much a work-in-progress, but it is being used to generate Subspace documentation on each commit.

Compiler Support

Subspace is a concept-first library and requires C++20. Compiler support for C++20 varies, and with active development ongoing, bugs in their implementations still appear and disappear regularly. When in doubt, check out which compiler versions are used by the CI bots.

Compiler Version
Clang: 16 and up
GCC: 13 and up
MSVC: 17.4.2 (not newer versions)

We attempt to work around bugs when reasonable, to widen compiler version support. See compiler_bugs.h for the set of bugs we are aware of and currently work around.

subspace's People

Contributors

danakj avatar dj2 avatar

Watchers

James Cloos avatar

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.