Giter VIP home page Giter VIP logo

bunsen-docs's People

Contributors

capn-damo avatar hjdskes avatar johnraff avatar lcafiero avatar rbh-se avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

bunsen-docs's Issues

Add section in helpfile-menu.txt for editing pipemenus as user.

At the moment the suggested method for modifying the bl-pipemenus is to edit, as root, the files in /usr/bin. As is pointed out there, this leaves the possibility of changes after a package upgrade.

I would suggest this method be advocated instead:

  • Copy the file from /usr/bin to ~/bin (create directory if necessary).
  • Check ~/bin comes first in $PATH.
  • Edit the local file.

Provide man pages for all bl-* commands

Some PoC work has already been pushed to the manpages branch. I intend to subsequently re-write all help files into man pages, and at that occasion also bring them up to man page quality -- eg the explainations for the conky commands are impossible to understand without prior knowledge and/or much trial-and-error play.

Instead of writing man pages directly, I am using pandoc for converting simple markdown documents into man pages.

Path to docs

I think the more appropriate path to helpfiles would be /usr/share/bunsen/bunsen-docs/ rather than /usr/lib... which suggests something executable.

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.