Coder Social home page Coder Social logo

README about inops HOT 8 CLOSED

moodymudskipper avatar moodymudskipper commented on September 27, 2024
README

from inops.

Comments (8)

moodymudskipper avatar moodymudskipper commented on September 27, 2024

@KKPMW I've added a README, but I'm not very good at readmes :) . Can you take a look ?
I think the package should be pretty much done now, we should just make sure the doc of the functions is OK as I haven't looked at it for a long time.

from inops.

moodymudskipper avatar moodymudskipper commented on September 27, 2024

de1e676

from inops.

karoliskoncevicius avatar karoliskoncevicius commented on September 27, 2024

Thanks! Will look over the README and all other changes as well, and will see if I can add/improve anything. I am also not a good README writer (look at the READMEs for my packages here on github heh..) and on top of that - I have a mild fever currently. But want to contribute, so cloning the repo and looking over it now.

from inops.

karoliskoncevicius avatar karoliskoncevicius commented on September 27, 2024

my suggested version in #24

from inops.

moodymudskipper avatar moodymudskipper commented on September 27, 2024

Cool, I like your structure much more, and the table is a good idea. Did you put it in code for a reason, rather than displaying a markdown table?

from inops.

karoliskoncevicius avatar karoliskoncevicius commented on September 27, 2024

I don't like the zebra stripes in GitHub table rendering. Also when you put normal text in one column but code in another it makes it look even weirder. When it's all in code the table is more "flat" looking. That's the only reason...

from inops.

moodymudskipper avatar moodymudskipper commented on September 27, 2024

Alright, I'm not sure if it looks less weird to have a table in a code block but that's a detail either way. I think we can close this then

from inops.

karoliskoncevicius avatar karoliskoncevicius commented on September 27, 2024

@moodymudskipper I think you are right - README seems to look better with normal tables here. If you want that version - it's in branch dev_readme now.

from inops.

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.