Giter Club home page Giter Club logo

Comments (4)

searls avatar searls commented on July 23, 2024

I honestly don't know. If someone googles scripty or runs any of those commands they'll probably immediately realize what it does.

¯_(ツ)_/¯

from scripty.

ashleygwilliams avatar ashleygwilliams commented on July 23, 2024

hey! i think this is a p good question, though i don't think the solution lies with any technical extension of scripty. a Gruntfile or a Brocfile is baffling to a user unfamiliar with Broccoli or Grunt. Similarly, the appearance of any framework or platform enforced abstraction is going to be confusing to people who aren't familiar with that framework or platform.

i always recommend documenting the frameworks a project uses, and npm scripts are a platform of sorts. i think it's a good README section, and to that end, i'd do something like:

npm scripts

MyProject uses scripty to organize npm scripts. the scripts are defined in the scripts directory. In package.json you'll see the word scripty as opposed to the script content you'd expect. For more info, see scripty's GitHub.

{{ insert table containing script names and what they do, e.g. this }}

from scripty.

boneskull avatar boneskull commented on July 23, 2024

@ashleygwilliams great idea. thanks!

from scripty.

searls avatar searls commented on July 23, 2024

Closing, I hope that #32 is sufficient for now. Thank you for the feedback, @boneskull

from scripty.

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.