Code Monkey home page Code Monkey logo

cpplot's Introduction

pre-commit black-girls-code

cpplot

Interactive graphs and charts for C++ 11 upward, viewable in-browser using cpplot-viewer.

Full documentation is at https://cpplot.readthedocs.io

For Developers

You should only need to read the following if you plan to develop on cpplot.

Style guide

We use the Google C++ style guide with the following exceptions:

  • Don't care about line width so long as its within reason
  • Use 4 space indenting, not 2 as suggested by the style guide, because we're not total monsters (just kidding xx).

Pre-Commit

You need to install pre-commit to get the hooks working. Do:

pip install pre-commit
pre-commit install

Once that's done, each time you make a commit, the following checks are made:

  • valid github repo and files
  • code style
  • documentation builds correctly

Upon failure, the commit will halt. Re-running the commit will automatically fix most issues except:

  • You'll have to fix documentation yourself prior to a successful commit (there's no auto fix for that!!).

You can run pre-commit hooks without making a commit, like:

pre-commit run build-docs

which is useful to locally build documents without crazy efforts setting up an environment for sphinx.

Compilation with cmake

A cross-platform compilation file is provided using cmake, but it's not tested on windows.

PRs to fix or improve it for windows are most welcome.

cpplot's People

Contributors

thclark 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.