Don't Create Markdown ReadMe Files Without ReadMe.so!!

แชร์
ฝัง
  • เผยแพร่เมื่อ 28 ส.ค. 2024

ความคิดเห็น • 99

  • @sampsonorson
    @sampsonorson 3 ปีที่แล้ว +72

    Please, consider telling the team to make this an extension to some of the popular code editors.

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว +10

      That's a good idea!

    • @MrDjZarko
      @MrDjZarko 3 ปีที่แล้ว

      it's awesome idea

    • @pirx1269
      @pirx1269 3 ปีที่แล้ว +1

      Already exist, I use it in vim and vscode

    • @MultiWillow33
      @MultiWillow33 3 ปีที่แล้ว +9

      @@pirx1269 so basically it exists but is not good enough to mention its name?

    • @abhishekpratap05
      @abhishekpratap05 3 ปีที่แล้ว +1

      @@MultiWillow33 there are 100+ extensions for readme, or markdown preview. Even VSCode has one built in.
      But this is not available.

  • @osuohiaemmanuel3234
    @osuohiaemmanuel3234 3 ปีที่แล้ว +27

    Cool for me. From now on I think I will start creating readme files 😁

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว +1

      Awesome! Glad you enjoyed it!

  • @ianliu88
    @ianliu88 3 ปีที่แล้ว +16

    Ahh my eyes, its README not ReadMe :P

  • @srnightmare0981
    @srnightmare0981 3 ปีที่แล้ว +9

    me: making github readme for vsc theme, gets yt notification from james. James: YOU ARE WRONG

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว +2

      Haha whatever works best for you. That’s all that matters!

  • @npf21
    @npf21 3 ปีที่แล้ว +4

    Not bad at all, I like how simple it is to properly structure your readme file. One thing that would be nice is being able to upload your readme file and recognize the certain sections

  • @justinmclawhorn3994
    @justinmclawhorn3994 3 ปีที่แล้ว +5

    Nice! I had been using Typora (& still absolutely love it, esp. for blogs), but I’m gonna have to give this a go for my next README.

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว

      Awesome. Let me know what you think when you do!

  • @mymarginalia8349
    @mymarginalia8349 3 ปีที่แล้ว

    Just a few days ago I got, what I thought unique, idea to document my APIs as I was creating them (helpful for beginners like me). I realize I was jumping through hoops to do it, this is so elegant.
    I'm going to start with adding Title Description, Environment Variables, running locally, deployment, API reference, Screenshots to all my repos that don't have a read me.
    I was going to recommend that Katherin should add local storage to remember our preferences but she did that - fantastic.

  • @kevinrobertandrews
    @kevinrobertandrews 3 ปีที่แล้ว

    Gotta admit, I was skeptical about watching a video about making readmes, but this is awesome!

  • @hemanthkotagiri8865
    @hemanthkotagiri8865 3 ปีที่แล้ว +17

    Holy smokes, this saves me a ton of time. Like, 35% of my coding stats(wakatime) is Markdown and that's crazy. Thank you for this!

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว +2

      Yasss! Love to hear this :)

  • @Tokur-zi7xf
    @Tokur-zi7xf 3 ปีที่แล้ว +1

    Literally just spent some of this weekend practicing and getting familiar with markdown to update my project readmes....this will save me some time.

  • @Brandon-tz5pn
    @Brandon-tz5pn ปีที่แล้ว

    Thank you. I've been coding for a while now and never understood the README files.

  • @yadusolparterre
    @yadusolparterre 3 ปีที่แล้ว +3

    Nice project, but maybe more suited for an Emmet snippet, no?

  • @MCTVARG
    @MCTVARG 3 ปีที่แล้ว

    Great video! Thanks for sharing this! I was used to doing markdown on my own, but this really helps on things like tables

  • @mikamulperi
    @mikamulperi 3 ปีที่แล้ว

    You can see live preview of markdown in vscode also.

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว

      True but you don’t get the block templates :)

  • @wtfdoiputhere
    @wtfdoiputhere 3 ปีที่แล้ว +2

    Or just use vscode with the split screen preview feature ?

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว

      Lol but that won't help generate some of the markdown for you. Live preview does work well though

    • @wtfdoiputhere
      @wtfdoiputhere 3 ปีที่แล้ว

      @@JamesQQuick elaborate bcz im not super hardcore on Markdown so i might be missing stuff here

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว

      @@wtfdoiputhere You can preview your markdown in VS COde but this tool Readme.so will help generate markdown for you which is nice. It gives templates for different sections you can add to your readme.

    • @codecleric4972
      @codecleric4972 3 ปีที่แล้ว +1

      @@wtfdoiputhere I thought the same thing but I had this video on in the background.. When I checked it again I realized it had all these pre-written markdown snippets. Yeah live preview in Vscode is nice but it doesn't have the snippets like this does. That's the real benefit of using this site

    • @wtfdoiputhere
      @wtfdoiputhere 3 ปีที่แล้ว

      @@codecleric4972 amazing imma try it

  • @jiribeck3235
    @jiribeck3235 3 ปีที่แล้ว

    Looks like great time saver and "do one thing and do it right" tool! Maybe making it vscode (or other IDE) extension will be great, but already installed it as Chrome App and going to use it for my projects.

  • @javierrenteria3195
    @javierrenteria3195 3 ปีที่แล้ว

    Wow!!!! It's been the best video I have never seen!!! Dude, thanks a lot to make this video. You have made my life more easier. Jajajaja inmedialy I'm going to subscribe. 😁😁

  • @rajibdesai
    @rajibdesai 2 หลายเดือนก่อน

    Thanks for helpful vddio . I am new learner ... cant't understander commit changes ?

  • @mskiptr
    @mskiptr 3 ปีที่แล้ว +2

    .so? Yeah, let's have dynamic libraries to link to our readmes

  • @jayrenegade3009
    @jayrenegade3009 3 ปีที่แล้ว

    This is amazing, thanks for sharing James, It would be awesome if something like this can be add into a plugin for Nuxt-content

  • @manglesh0605
    @manglesh0605 3 ปีที่แล้ว +1

    thank you for the vs code shortcut video ..loved it.

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว +1

      You’re welcome :)

  • @damonx99
    @damonx99 3 ปีที่แล้ว

    That’s awesome. Thanks for sharing with us.

  • @syamsajimon8266
    @syamsajimon8266 2 ปีที่แล้ว

    i am just started heck ya this is easy to use

  • @kennyakins3536
    @kennyakins3536 3 ปีที่แล้ว

    I love this. This saves me a lot of time 🙂, definitely would be using this.

  • @MetalManiacBoy
    @MetalManiacBoy 3 ปีที่แล้ว

    Yo thank you! This is a wonderful tool, thank you for talking to us about this :D

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว +1

      Make sure to show Katherine some love as well :)

  • @Martin-4D
    @Martin-4D 3 ปีที่แล้ว

    Looks great! I might have to learn mark down now :D

  • @getbest50
    @getbest50 3 ปีที่แล้ว

    This is great. Thanks for sharing this.

  • @noobCoder26
    @noobCoder26 3 ปีที่แล้ว

    Looks super interesting and helpful

  • @flylord4361
    @flylord4361 3 ปีที่แล้ว

    Code has some nice plugins for this. No need to overthink.

  • @rahulsriram6295
    @rahulsriram6295 3 ปีที่แล้ว

    So cool! Thanks for this video

  • @robokishan
    @robokishan 3 ปีที่แล้ว

    awesome man!

  • @nonstopper
    @nonstopper 3 ปีที่แล้ว

    Wow, Definitely needed this

  • @alexanderanastasiadis9284
    @alexanderanastasiadis9284 3 ปีที่แล้ว

    You save my life bro :) Project has any donation button ?

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว

      Yes, if you go to the website and generate a ReadMe, it has a done button :)

  • @scorpion32
    @scorpion32 3 ปีที่แล้ว

    I love it but for some reason I can't add gif files for the demo tab, I have to do it at the back end on github before upload

  • @jefjef418
    @jefjef418 3 ปีที่แล้ว

    Thank you!

  • @DamianDemasi
    @DamianDemasi 3 ปีที่แล้ว

    How was this project built? It looks like an awesome project to practice web development programming.

  • @afzalmahmudd8365
    @afzalmahmudd8365 2 ปีที่แล้ว

    Like it ❤️. Soo cool.

  • @youtubeoneverything4581
    @youtubeoneverything4581 3 ปีที่แล้ว

    This is a life saver!!!!!!!

  • @vicsystems
    @vicsystems 3 ปีที่แล้ว

    This is really helpful

  • @dasten123
    @dasten123 3 ปีที่แล้ว

    Very cool tool!

  • @patgerke
    @patgerke 3 ปีที่แล้ว

    Ah! this is fantastic!

  • @srinivasanr4491
    @srinivasanr4491 3 ปีที่แล้ว

    Wow, This is so cool.

  • @Dan-zg8wr
    @Dan-zg8wr 3 ปีที่แล้ว +1

    Don’t see why one would use this when extensions can achieve the same thing locally. Nicely built site though

  • @hazemhasan4931
    @hazemhasan4931 3 ปีที่แล้ว

    thanks, very usefull

  • @donmorris4506
    @donmorris4506 3 ปีที่แล้ว +2

    Pretty cool but I think I still prefer Ulysses since I can export to html, rtf, pdf.

  • @georgesfeungap9737
    @georgesfeungap9737 3 ปีที่แล้ว

    Perfect

  • @jacqueskloster4085
    @jacqueskloster4085 3 ปีที่แล้ว

    asciidoc is still not getting enough attention
    why should it? it aims for a well established standard instead of leaving you with a flavoured markdown hell

  • @krtirtho
    @krtirtho 3 ปีที่แล้ว

    I wish there was a CONTRIBUTION.so too

  • @VeaceslavBARBARII
    @VeaceslavBARBARII 3 ปีที่แล้ว

    Kyle Cook's next video: *Creating a **readme.so** clone*

  • @TymoteuszCzech
    @TymoteuszCzech 3 ปีที่แล้ว

    YAGNI

  • @sarcasticdna
    @sarcasticdna 3 ปีที่แล้ว

    Mic is so dirty 😅

  • @armynyus9123
    @armynyus9123 3 ปีที่แล้ว +1

    Uh oh... the fact that pretty much everybody is freaking out because of *this*, makes me a bit worried about the quality of the code, github is spammed with, these days.

    • @null_spacex
      @null_spacex 3 ปีที่แล้ว

      Why you gotta be such an elitist?

    • @armynyus9123
      @armynyus9123 3 ปีที่แล้ว

      @@null_spacex Did I sound so? I beg a pardon, I'm definitely average regarding programming skills. But still, I think software development is about automation of repetitive tasks and the editor is pretty much the only tool for a developer.
      I doubt you could be even average as a developer, when you did not invest the time into sharpening your axe.

    • @null_spacex
      @null_spacex 3 ปีที่แล้ว

      @@armynyus9123 i got ya but i disagree that the editor is the only tool.. it is def the main tool but there's a lot of diff tools to be used depending on your skill level or laziness level i guess

    • @armynyus9123
      @armynyus9123 3 ปีที่แล้ว

      @@null_spacex Agreed. Especially at my bigger customers, the "developers" there have something like powerpoint as their main tool...
      Guess I was more talking of the underpaid, replacable (in the eyes of the managers) loosers who do the actual work until (again in the eyes of the managers) AI is ready to finally give them their deserved kick in the butt ;-)

  • @PatrickKellyLoneCoder
    @PatrickKellyLoneCoder 3 ปีที่แล้ว +1

    This comes off like a paid sponsorship that wasn't disclosed as a paid sponsorship.

  • @babakfp
    @babakfp 3 ปีที่แล้ว

    Please change your glasses. You look funny❤

  • @TwstedTV
    @TwstedTV 3 ปีที่แล้ว

    Would be nice if this could be done in the editor :) just saying hehe :)

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว +1

      Maybe that’s the next step!

    • @armynyus9123
      @armynyus9123 3 ปีที่แล้ว

      Hint: Maybe start using a *real* Editor? It's worth the time invest...

    • @TwstedTV
      @TwstedTV 3 ปีที่แล้ว

      @@armynyus9123 what do YOU, consider a real editor.?

    • @TwstedTV
      @TwstedTV 3 ปีที่แล้ว

      @@armynyus9123 Thanks, I hate Vim, I cant stand Vim, I will never use Vim. I'll stick with VS-Code. :)

    • @armynyus9123
      @armynyus9123 3 ปีที่แล้ว

      @@TwstedTV then check out emacs ;-) e.g.: ?v=0g9BcZvQbXU
      vscode is ok for an ide - but only to a certain point, sooner or later you'll hit the wall.

  • @chrisdizzle313
    @chrisdizzle313 3 ปีที่แล้ว +1

    How is 1 person going to thumbs down this video? Come on ppl.

  • @abbaadamu3927
    @abbaadamu3927 2 ปีที่แล้ว

    All greate coders use glasses 🤓, and you my friend are a greater coder damnit

  • @thecodetex
    @thecodetex 3 ปีที่แล้ว +1

    First comment Awesome video

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว +1

      Nicely done! And thank you :)

    • @thecodetex
      @thecodetex 3 ปีที่แล้ว +1

      @@JamesQQuick Your Welcome

  • @Liproqq
    @Liproqq 3 ปีที่แล้ว

    first minute was no information at all. just clickbait talk. I already clicked on the video. :(

    • @JamesQQuick
      @JamesQQuick  3 ปีที่แล้ว

      Sorry you feel that way. I really enjoy this product.