Giter Club home page Giter Club logo

dbg's People

Stargazers

 avatar

Watchers

 avatar

Forkers

xexyl

dbg's Issues

Discuss documentation

As you requested on the mkiocccentry repo I am opening this here.

To start out: what do you think should be changed with the man page? If you think it's complete for now how would you like it to be referred to in the README?

Looking at the repo I think it would be good if the README could be dramatically cut in size. I don't know what most people would prefer but I think some might look at the length (even with the tl;dr part) and look for something else instead. But perhaps with just the tl;dr part referring to the man page (which actually has an example program) and another file that has more details (not sure what it would be called - maybe something to do with the api? I really don't know) it might seem much less formidable to some people?

Just some initial thoughts to get a discussion started.

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.