Code Monkey home page Code Monkey logo

Comments (2)

Icy-Thought avatar Icy-Thought commented on July 28, 2024 1

The man-page in my opinion needs to be an explanation of what certain features in the program does and perhaps even explain why they work that way. For example, I was confused by what Closure Size and NAR Size meant when I first started using the program. (never came across those terms before now, which explains the reason for my confusion)

The style of the man-pages could also be of a TL;DR style to not have people become bored of the man-pages while reading it and instead retain that information in the GitHub repository if so desired.

And for how you could style the man-page, take a look at man nix. :)

from nix-tree.

utdemir avatar utdemir commented on July 28, 2024

Thank you, I do think this would be very useful.

I believe it'd be easy to implement this technically as you suggested:

  • We populateman nix-tree
  • nix-tree --help would execute man nix-tree instead
  • Help shortcut in nix-tree can also open the man page, and exiting it would go back to the application
    • I think with your other suggestion on #49 , the contents of the help modal right now would become redundant anyway.

But I guess I do not have a clear idea on what that man page should look like. Currently nix-tree have some docs here: https://github.com/utdemir/nix-tree#usage . They don't seem enough to be, but I'm unsure what else I should add. Do you have any ideas? What kind of structure does that man-page needs?

from nix-tree.

Related Issues (20)

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.