Coder Social home page Coder Social logo

Proper Readme about tax-calculator HOT 4 CLOSED

pslmodels avatar pslmodels commented on August 21, 2024
Proper Readme

from tax-calculator.

Comments (4)

iliakur avatar iliakur commented on August 21, 2024

@MattHJensen here's something we could do: if we're working on resolving an issue, we could post our commits in the issue's thread so that a) there's record of some progress in case we get distracted and have to put it on the back burner and b) so that people can maybe discuss this progress in its intermediary stages.

For instance, I'm going to link to your most recent commit on this topic like so:
55e74a9

The easiest way to grab a commit link is by going to the repo's home page, then clicking on "commits" under the repo name. You'll see a list of commits and to the right of them buttons that allow you to copy a commit's hash code into your clipboard. You then simply paste the commit hash into your message here and it will appear as a link.

from tax-calculator.

MattHJensen avatar MattHJensen commented on August 21, 2024

Sounds good. Thanks.

from tax-calculator.

talumbau avatar talumbau commented on August 21, 2024

I like the idea of text in the README that describes how to get started. I think a good goal would be to have these sections:

  • Installation (maybe with a couple of options)
  • How to run the tests
  • Links to relevant sites

from tax-calculator.

talumbau avatar talumbau commented on August 21, 2024

we have progressed beyond a README. Closing in favor of other issues to discuss doc needs.

from tax-calculator.

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.