Do all the things like ++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatarSign Up
Get a devDuck
Rubber duck debugging has never been so cute! Get your favorite coding language devDuckBuy Now
Search - "readme"
We have a bunch of white people in human resources that are trying to hire "diverse" people because the company sets HR diversity targets. Which is an inherently racist way of hiring someone.
I am told to interview this guy who claims to have Angular experience. Before the interview I ask to see a form that he has built in Angular. He sends me a repo which is ripped off of an open source project and has the readme and git commits removed. A quick web search shows that it isn't his work. He shows up to the interview and I find out he is from a Southern African country. I deliberately ask some questions about code that I can see he didn't write that I prepared ahead of time. He lies to me and tells me all about how he wrote it which showed me that he has no idea what the code does. I tell HR they better not hire him because he was very comfortable lying to me, and I'm confident that he doesn't understand any of the code that he showed me. I do not trust this guy and would never choose to work with him. HR lady says "Ah okay."
Today he walks in with a big grin on his face. HR lady fucking hired this guy. I can see his monitors from my desk and he spent his whole first day looking at a soccer website on his second monitor. I call up HR, "Why would you even ask me to interview him if you refuse to listen to my feedback?". Lady tells me "You need to be open minded about diversity. Probably most of the things you observed were either cultural differences or language barrier." I tell her definitely not. He lied to me multiple times, and he took credit for other people's work." She tells me that they will keep an eye on me because I'm not being open to diversity.
Are you kidding me? This white lady is literally stereotyping me as a racist because I'm white.
So this fucking HR lady called me a racist because she decided to hire someone that we shouldn't trust. Then she put this asshat on my project. Now I have to be cautious about my position because HR is "watching" my racist ass. Even though I am literally the only one on the development team that is white and speaks English as my first-language. I called a team meeting before the on-boarding is over so I can tell the other developers what is happening. We restructured our code review process so that I will never give him feedback. Then when the time comes that he slips up the "diverse" developers will kick him out so I won't be reprimanded as a "racist".
This company that I work for is a special kind of stupid.36
Finished the script for calming* rants and comments down and even made a fancy readme this time:
Me telling a senior dev on how to install a proprietary software:
Me: Sir, the instructions are in the readme.txt
Senior: I'm supposed to read the readme?!4
A repo on GitHub I'm maintaining has grown with 200k downloads / month since I started working on it a year ago. My recipe? I added an npm badge in the readme showing downloads / month and I responded to every issue and reviewed every PR. Now there's so much issues and PRs coming in that we had to add an extra maintainer, feels great! Teamwork, fuck yeah!
Not every PR got merged of course, but every single one of them got reviewed. Just being a good and friendly developer, giving back to the community that has given me so much. Some tips for you maintainers out there. If you have a popular project and no time there's always someone else who's willing to spend time on it, ask around and you will surely find someone else.7
So I have been freelancing as web developer for 5 years. I was also playing basketball professionally so I was only working part-time, building websites here and there, small android apps to learn the job and I was also reading a lot to challenge my brain.
When I stopped playing basketball about a year ago, I thought I would really enjoy coding full time so I pursued a job.
With no formal education and just a basketball background on paper, in the collapsed Greek economy, as you may assume chances of landing a job are minimal.
After about 40 resumes sent I only got an internship. It was a 4 month, part-time, no pay deal, and then the company would decide if they would like to hire me later.
The company had 4 employees and they are one of the largest software distribution businesses in my area. They resell SaaS bought from a third company, bundled with installation support, initial configuration, hardware support, whatever a client may need.
I was the only one with any ability to code whatsoever. The other people were working mostly on customer support with the occasional hardware repair.
After the 4 month period they owner (small company, owner was also manager and other roles) told me that they are very happy with my work and would like to keep me part-time with minimum pay.
Just to give you and idea if the amounts of money involved, in Greece, after taxes, my salary was 240euros per month. And the average cost of surviving (rent, cheapest food possible, no expenses on anything but super basics) is about 600euros.
I told him I needed more to live and he told me ok, we will reevaluate a few months later, at the end of May 2017.
I just accepted it without having many options. The company after all was charging clients 30euros per hour for my projects so I kept thinking that if I worked a lot and delivered consistently I would get a full time job and decent money.
And I delivered. In the following months I made a Magento extension, some WordPress themes, a C# application to extract data from the client's ERP and import it to a third application, a click to call application to use Asterisk to originate calls from the client's ERP, a web application to manage a restaurant's menu and many more small projects. Whatever they asked, I delivered.
On time, version controlled, heavily documented solutions (my C# ones are not exactly masterpieces but it was my first time with the language and windows).
So when May ended I was pretty excited to hear they wanted to keep me full time. I worked hard for it, I was serious, professional, I tried a lot to learn things so I can deliver, and the company recognized that. YAY.
So the time comes to talk money. The offer was 480euros per month. Double my part-time pay, minimum wage. I asked for about 700. Manager said it's hard but I will see what I can do. So we agreed to keep the deal for June while they are working on a better offer.
During the first half of June I finished my last project, put all my work on a nice folder with a nice readme on every project's directory, with their version control and everything.
The offer never improved, so I said no deal, and as of today, I am jobless.
I am stressed as fuck and excited as fuck at the same time.
I will do my best to survive in the shitstorm that is called Greece.
Bring it on.9
You know how some people put those little badges in their readme files in GitHub?
Well, one of my team members didn't know how to make those work correctly, so they just plastered images of them to make our repo look good. In actuality we have no coverage, no testing, no nothing...6
I've recently made a devrant API for python!
It is available for use in your very own projects!
Here is the link: https://github.com/coolq1000/...
It is very basic with functionality, not much beyond getting rants by index starting at zero, or getting all rants available by skip, limit.
Has some documentation in the readme.
"when i die i want my group project members to lower me into my grave so they can let me down one last time"
Last year in College, I had two simultaneous projects. Both were semester long projects. One was for a database class an another was for a software engineering class.
As you can guess, the focus of the projects was very different. Databases we made some desktop networked chat application with a user login system and what not in Java. SE we made an app store with an approval system and admin panels and ratings and reviews and all that jazz in Meteor.js.
The DB project we had 4 total people and one of them was someone we'll call Frank. Frank was also in my SE project group. Frank disappeared for several weeks. Not in class, didn't contact us, and at one point the professors didn't know much either. As soon as we noticed it would be an issue, we talked to the professors. Just keeping them in the loop will save you a lot of trouble down the road. I'm assuming there was some medical or family emergency because the professors were very understanding with him once he started coming back to class and they had a chance to talk.
Lesson 1: If you have that guy that doesn't show up or communicate, don't be a jerk to them and communicate with your professor. Also, don't stop trying to contact the rogue partner. Maybe they'll come around sometime.
It sucked to lose 25% of our team for a project, but Frank appreciated that we didn't totally ignore him and throw him under the bus to the point that the last day of class he came up to me and said, "hey, open your book bag and bring it next to mine." He then threw a LARGE bottle of booze in there as a thank you.
Lesson 2: Treat humans as humans. Things go wrong and understanding that will get you a lot farther with people than trying to make them feel terrible about something that may have been out of their control.
Our DB project went really well. We got an A, we demoed, it worked, it was cool. The biggest problem is I was the only person that had taken a networking class so I ended up doing a large portion of the work. I wish I had taken other people's skills into account when we were deciding on a project. Especially because the only requirement was that it needed to have a minimum of 5 tables and we had to use some SQL language (aka, we couldn't use no-SQL).
The SE project had Frank and a music major who wanted to minor in CS (and then 3 other regular CS students aside from me). This assignment was make an app store using any technology you want. But, you had to use agile sprints. So we had weekly meetings with the "customer" (the TA), who would change requirements on us to keep us on our toes and tell us what they wanted done as a priority for the next meeting. Seriously, just like real life. It was so much fun trying to stay ahead of that.
So we met up and tried to decided what to use. One kid said Java because we all had it for school. The big issue is trying to make a Java web app is a pain in the ass. Seriously, there are so many better things to use. Other teams decided to use Django because they all wanted to learn Python. I suggested why not use something with a nice package system to minimize duplicating work that had already been done and tested by someone. Kid 1 didn't like that because he said in the real world you have to make your own software and not use packages. Little did he know that I had worked in SE for a few years already and knew damn well that every good project has code from somewhere else that has already solved a problem you're facing. We went with Java the first week. It failed miserably. Nobody could get the server set up on their computers. Using VCS with it required you to keep the repo outside of the where you wrote code and copy and paste changes in there. It was just a huge flop so everyone else voted to change.
Lesson 3: Be flexible. Be open to learning new things. Don't be afraid to try something new. It'll make you a better developer in the long run.
We sat down one day and worked for 4 straight hours. We finished the whole project in that time. While other teams were figuring out how to layout their homepage, we had a working user system and admin page and everything. Our TA was trying to throw us for loops by asking for crazy things and we still came through. We had tests that ran along side the application as you used it. It was friggin cool.
Lesson 4: If possible, pick the right tool for the job. Not the tool you know. Everything in CS has a purpose. If you use it for its purpose, you will save days off of a project.1
Now don't get me wrong, I love the multicultural aspect of open source coding.
But for the love of everything that that is sane, please do not write the basic readme and code in English, and then write the entire documentation for the code in another language.
(Yay first rant)7
Thank you to everyone that is helping out with devCredits!
I honestly didn't expect people to bother contributing.. but apperently I was wrong.
For the people already working on it, check the readme file for a Todo list if you want something to do.
And for the people that want to help or just saw that this is a thing right now, check out my recent collab for info.
Collab link: https://devrant.com/collabs/...
Is it illegal to upload a malware(worm) written in python to GitHub? I'm serious :)
I've written a worm which I want to share with my friends (and possible future viewers). My intent is to share my experience. So that they can learn from it. What they are doing with it afterwards, shouldn't be my problem, I guess. (I will put a disclaimer warning in the Readme file of course)16
I finally got an acceptable version of my assembler done. Just a pic of my terrible code for now, I will share the links to it, my Virtual cpu emulator and my graphics emulator / driver once I am done writing readme files for them.15
Just give me a link to the web font man. Oh, there isn't one? You used a font that we can't legally use? Do you understand how that works? I don't want your 300MB photoshop document. I don't want to comb through your ridiculous stack of insane layers and artboards and deal with the images you didn't bundle into the project or try and make sense out of your arbitrary spacing and random font sizes. You're not an artist, you're just a crappy visual designer handing off an unthoughtful glorified wire-frame - and now I have to sort out all the things that you were paid to do. It's really easy. 1. Pick a color, 2. Pick 2 fonts that are legal and available to use on the web, 3. build a few patterns for font sizes and weights - write them down. 4. Pick your images. Make them double the size you expect them to be on the site + put them in a folder, 5. add readme and list the font patterns and the link to the webfont, 6. quickly scribble the wire-frame out, 7. take a photo of it, 8. put it all in a folder and send it to me.4
Keep your fucking petition and readme only shit to yourself or those fucking petition websites, that everybody uses to fucking wipe their ass with, you fucking limp dicked piece of skunk shit
I am already fucking blocking all sorts of media not to hear about all your whiney fucking crap, now I have to also fucking endure your brainless fucking justice warrior bullshit all over github, all over rss feeds, all over fucking everywhere
go fucking get smoked by a car or go fucking overdose, for all I care, just fucking smear yourself all over a fucking wall, as long as you keep your fucking worthless opinion away from me
the fucking worst of it all is that every fucking shithead out there puts it up your face, even if you blocked a million of those fucking clones, then somebody that you follow or a website you visit, will fucking shove that shit in your face, github is not for your fucking propaganda18
I was so proud of my recent tiny little node script that I published it on npm.
I really just kinda wanted to learn how npm worked. I don't expect anyone to find any use from this.
I wrote the README in a sarcastic tone if anyone is interested in reading that
You’re a fucking demon if you don’t include a README.md.
Thanks you for reading my GitHub complaint.4
This whole github thing is only yet again revealing, how many package maintainers are a bunch of instable psychopaths and should have somebody else manage the keys
be it one guy deleting all shit from npm and breaking worldwide babel installs or now raging toddlers deleting their repos with no actual readme notice or atleast placeholder repo and telling others to do the same
jesus fucking christ, how can the same person have developed such intricate package and then be an absolute manbaby throwing shit at strangers10
I am extremely particular about writing good READMEs in my repositories. I make sure that it has everything from prerequisites to run the code and tests on a new machine to how to actually run it (and the tests) and everything in between.
Despite all that I was asked questions that should have been avoided if you had seen the README.
One of these times was by a junior DevOps asking me about an error which was clearly due to him running the code without a virtual environment. Pings me with the entire stacktrace, I go to his desk and tell him to install the environment, which he does. 3 minutes later, another error message.
He was running the wrong script. I go to his desk again. Open the repository. Show him the README. Show him the section titled "To run the pipeline"!
There's a reason they're called README. You're supposed to READ them! 😑5
Pro tip for job candidates:
If you push a code challenge to a live hosting service like github pages or S3, don’t give the reviewers a link to the repo!! Instead put the link into the home page and send the reviewer only a link to the live hosted page.
Because, if you host with github pages, you’re required to use the project path as the domain root. If the reviewer pulls your project and doesn’t bother to read your readme file with the link at the top, he’ll complain that he couldn’t figure out why your project isn’t hosted from the root domain, and he’ll pass on your application.
I once worked with an obsessive tester who was bent on ‘testing’ the README file of a Software Distribution.
The README text file was in the distribution zip, so she had to unzip the thing before reading the file, however she insisted that her test result was a failure because there was no README that shows her how to unzip the distro to read the README!
I thought she was joking, but she was dead serious and escalated the ‘issue’ to the manager! I was furious, almost resigned from the project
In the end I had to suck it up and tolerated more weeks of her mindless obsession!6
As a follow-up to my comment on this rant: https://devrant.com/rants/1029538 I want to share with you my new project: BinToBmp!
It converts any file into a beautiful bitmap image illustrating all bytes as pixels. Each byte indicates an index to a color table (very happy bitmap makes it this simple).
Useful? No. Fun to make? Hell yeah!
Take a look at it on my github page:
Print your favorite song and hang it on the wall or make a shirt from your latest compiled application. So many possibilities!
More infos in the readme.
Updates coming soon :)
P.S.: The image displays the converted jar.32
so... I have this project for school... we have to choose something that we are interested in and learn about it. then we have to make something for our "end result".
so the topic i chose is looking at how computers actually work (basically learning x86 assembly) then making a huge readme document on github that shows how to do things in python and assembly (to show the difference between an interpreted lang and machine code)
i also need to talk to or work with someone that knows something in my chosen field. so if any of you want to, i will have a link to the github repo in the comments. it would be greatly appreciated if you could add some of your own examples / tutorials and knowledge. also having someone read over this and correct things would be nice. if you do contribute, i have a contributors file in the repo. feel free to add your name to the file. i will give you credit in the end project.
so.. ya. it would be greatly appreciated if you could help out or give me some suggestions.27
Github README: Try the demo before getting started.
Me: Runs the demo
Demo: 96 errors with 32 warnings
VS: Run the latest build?
Demo: (evil laugh)
Me: F### you dev!4
Arch that I've had for a month
Applications: Firefox with riot.im chat, custom one-line music menu, vim markdown preview, gotop, vim with .zshrc, vim with README in Markdown, vim with python code
Arch Linux, i3 WM14
I was amazed by looking at the design of WordPress readme at GitHub.
It's really amazing, just as good as the WordPress websites.
Please have a look
(And the url also makes sense)
> be me
> work on a nice project with friends: A, B and C
> joined in a bit later, but before any real progress was made + we scrap the existing code, because it was Python2 or something
> decide on a framework
> A wants to create one himself, instead of using an existing one
> we fight for a little, but let A do his thing
> 2 months later
> been waiting the whole time
> +1000 lines on github, but still not finished
> "Wouldn't it be better if we would use the normal framework?"
> "No, mine is hand-crafted for that task"
> "But it is full of bugs"
> "If you find one major bug, we'll ditch my framework"
> finds major bug
> "That's fixed, just give me a min-"
> finds another bug
> "Thats just because you don't know how to use the framework"
- Documentation inside ONE gigantic README
- Library is missing the core features we needed/those which are implemented don't work
- Both B and C were on my side from the beginning (in that we should use "Already Existing Fully Documented Popular And tested Framework Which Does Everything We Need")
> "But i dont understand this framework so explain it to me"
> send him a few code examples + a tutorial??? (dont remember if i actually sent im the tutorial before i left)
> "explain it to me, i can't understand it"
> I CANT UNDERSTAND YOUR FUCKING FRAMEWORK DUMBASS
> ragequitted the server+project
To this day i still don't know, which framework they are using..
Also that Python 2 code in the beginning was because A didnt know the difference and copied (yes by hand) the code from atom to github without testing anything.3
I spent a *very* long time trying to work out why my README file wasn't formatting....
It didn't have a .md extension.
I'm a fan of writing tests right after you write every module. I actually think it's doable.
But I'm not a big fan of traditional TDD, which is defined as: first writing the tests, making them fail, writing code until tests don't fail.
My experience with traditional TDD when writing library code is that you start with this very naive idea of what is needed, so you write classes and functions and a lot of times they look like overly simplistic pseudocode.
So what do you do? You scratch that, you delete those classes/functions several times.
I think this discovery process that your code is naive is slowed the fuck down by doing TDD.
I'd rather write a theoretical API in a readme file, then write code, and then write the tests, you can even withhold writing the tests, but never leaving them for another day, just so that you don't waste time writing tests that you're going to scratch.
There's always a time constraint, and most of us can't afford bikeshedding.
Traditional TDD feels like an esoteric thing, it tries to make programming a series of steps, it actually sounds like an infommercial.
"FOLLOW THESE 3 SIMPLE STEPS AND WRITE THE BEST CODE EVER"13
I have just released a huge update to dr!
This update includes commenting, viewing comments, voting, better backend, and much more!
If you haven't already downloaded the client, go to:
Be sure to read the README!
(Yes, I know some commands take a long time to execute. A lot of data parseing happens in the background. This is being worked on.)4
So I found this consulting job a while ago thinking that some extra cash while studying would be nice to have.
I meet with the guy, a researcher trying to start a business up, good for him I think, maybe we'll hit it off, continue working, why not? Except he has no clue how to write working code, all he ever did was writing matlab scripts he says, thats why he hired me he says.
Okay, fine, you do your job I do mine.
He hands me the contract, its about comparing two libraries, finding out which one is better suited for his job, cool, plots and graphs everywhere.
Except this is an unpaid job. YOU WHAT?! It's a test job. FINE. At least it'll look good on my resume.
We talk about the paid part where I'm supposed to scale the two libraries, looks good, as expected from an ML engineering perspective. It comes to payment. The dude has no idea how taxes work, says he has a set amount to pay and not a penny more. I explain with examples how taxes are paid, how you get reimbursed for them and so on. Won't budge. Screws me over.
Opens the door for other jobs I think, he'll learn next time I think and take the job.
Fast forward a month, 90% of the job done, he adds a third thing to compare. Gives a github link to a repo with 2 authors, last commit a year ago. There are links to a 404, claiming compiled jars. Fuck.
Not my first rodeo, git clone that shit, make compile, the works. The thing uses libs that ain't in no repo, that would be too easy. Run, error, find lib, remake all the things, rinse repeat.
The scripts they got have hardcoded paths and filenames for 2 year old binaries, remake that shit.
It works, at least I get a prompt now. Try the example files they got, no luck, some missing unlinked binary somewhere, but not a name mentioned. Cross reference the shit outta the libs mentioned on readme, find the missing shit, down it.
Available versions are too new, THE MOLDING NUTCRACKER uses some bug in an old version of the lib.
I give up. Fuck this. This ain't worth the money OR time. Wanker...
Developer of said repo notices the influx of activity, but then just updates the readme by saying there are bugs, not fixing.
Bro I just gave you a PR. Take the fucking PR and that will fix the bugs.
Hey everyone, cozyplanes here with another quick excel prank i thought of.
It is called TEEST, and the technique behind is simple, but interesting. Recommend taking a look, and pranking with your friends.
The following is the README of TEEST (Text in Excel Every Single Time) in Github.
You can check the simple project here ( https://github.com/cozyplanes/teest )
Disclaimer: Do not use or modify neither the program or the source code to make software violating the law.
### How do I use it?
1. Head to https://github.com/cozyplanes/teest and download the latest release `EXE` file.
1. Windows may warn you with the missing signature. The file is a DEBUG file, so there isn't a publisher signature. You can proceed downloading anyway since it has been virus checked by the developer.
2. Type the message you want to display in the textbox.
3. Click `Save text` button.
5. To check the file, click `Cancel` button in the opened popup dialog.
### What happens?
When an MS Excel file (`.xlsx`) has been opened, by using TEEST, two files gets opened.
1. The original file user opened
2. Excel file named `message.txt` with the custom message you have written.
`message.txt` excel file will open every single time a person opens a excel file.
*In some older versions of Excel, the message may overlap with the user opened file.*
### Why does this happen?
When MS Excel program is executed, it is programmed to check the files in the following 2 folders.
- `C:\Program Files\Microsoft Office\Office[versionnumber]\XLSTART`
In normal conditions, there is no file in those folders (or the folders doesn't exist at all) but when you use TEEST and click `Save text` button, it saves `message.txt` file in the folders above. From MS Excel is executed again, it will find out there is a file in the folders above, so it will show those text files in Excel.
### Where is this technique used?
There should be a lot of software using this trick, but it is widely known for ransomwares such as `GandCrab` and `TeslaCrypt` displaying decryption methods in MS Excel by this trick.
### How can I disable it?
1. Open TEEST again.
2. Click `Save text` button and click `Cancel` in the following popup.
3. Delete `message.txt` file in the opened explorer.
This software is under the MIT License. Refer to the `LICENSE` file for more information.
Spam/Ads not allowed. Please only send questions or concerns about the software. It may take up to 48 hours to get a reply.13
A quick rundown of progress on kuronbka (now official game name) :
1) Made the Readme markdown file. Important
2) Set up the repo on my PC
3) Fixed some bugs
4) Added movement in the right direction. The chicken can jump and will go back down (A button). The code is yet uncommented, but I just wanted to commit it by today.
Internal mail form CIO's office:
"Thank you for being part of the internal trial for NPMe, we have decided to remove this tool in favour of Artifactory because of its support for multiple platforms and tools. We are sorry for the inconvenience, here is a link to migration scripts ..."
Migration "script" readme, please clone this repo, create file A, and B, and install these 2 dependencies.
- "install via homebrew ..."
- .... homebrew needs to update, checking for updates
- 10 mins later = Update failed, please upgrade to Ruby version 2.3
- Installs ruby version manager
- GPG signature verification failed
- Install GPG v2 + accept keys
- Install ruby version manager
- "please execute this command before running rvm"
- execute command
- "rvm install ruby-2.3"
- Install failed, please see log file
- Opens log file
- "Xcode on its own is not sufficient, please install xcode cli tools"
- Install xcode tools
- 5 minutes later -> "rvm install ruby-2.3"
- 10 minutes later "brew install jq"
Ok back to read me, "login to Artifactory, go here and copy paste XXX."
- Login to Artifactory
- Eventually find repo
- Login again to actually see credentials for some reason
- Screen doesn't match instructions in readme
- Click around
- Back to readme
- Back to artifactory
- Login again
- Execute command auth / setup command
- Copy contents to npmrc file .... now all my scoped packages are going to point to 1 specific repo
Fuck the migration, Fuck these shitty instructions, i'll set them all up again manually. See tags below for further opinions on this matter.2
1. Go to Github for you
2. Download the 'codes'
3. Send them as a pdf to you when the code is there in the repo.
4. Write you a step by step tutorial when there's a clear README.
YOU LAZY MOTHERFUKCER!2
So I found some weird library included in this legacy code, didn't really get what it does and why it's there though.
Turns out there's nothing to be found on the internet about it. Absolutely nothing.
So after browsing through the directory structure a bit more I discover a README file. Hoping for answers I opened it, only to find this...3
A couple of weeks ago I had an internship. I worked there with a classmate. We had a simple assignment, but since we're noobs when it comes to web applications (and because you don't learn that in school), we even had a hard time preparing.
Finally, I... I mean "we" decided to use React because it's close to the way we learned to solve problems in school. I asked him to implement a page with a date picker/calendar. I even searched for a repo that. 2 Days later he was still not able to implement it, he experimented with the code, but he
1. didn't even read the readme, just copied the tutorial expecting it to work
2. Didn't even look at the logic behind it.
3. Demanded to use this other repo with less functionality
10-30 minutes should have been more than enough. Instead, I wasted time telling him to read and code properly. He refused the second (and probably also the first), because "Why should I care? We'll be here for 3 weeks and then we're done with this"
Guess whom I'll avoid in any possible group project4
Still can't find a decent node MVC framework. Thought I'd list out all my requirments and what I'd like.
Turned into a readme of me moaning about current frameworks. Not sure I want this on github
Stop giving me pdfs, stop giving me word documents, stop giving me paper handouts. Just give me a README with the assignment on it that I can throw into a git repo where everything else I hand back to you is going to end up anyway.
It doesn't even have to be markdown'ed to death! I mean, that's a plus, and then you could, you know, have your example code's syntax lit up properly among other things. But a text file is all I really needed!1
I'm now maintaining a forked repo of a project that I got working in Android. The other project linked to my fork in the readme!
I seriously stoked about my first real open source contribution!1
I completed my 4 pull requests for hacktoberfest and guess what all of them got approved. Yayyy!!
So these are the issues which I fixed in hacktoberfest2019.
1. Fixed readme of imba
2. Fixed the script of devTea
3. Added screenshots for the same (2)
4. Helped a friend with a blockchain script.
Thanks a lot!! @devTea, for giving me the chance.6
Trying to understand other people's code like:
- 6 README, in total 7 lines (that's all there is for documentation)
- 40% of code is commentary like (original code, not altered...)
// if(a = b)
// c = d; // this is not working
I have two contributions so far in my first hacktoberfest. I have created a readme and updated a .gitignore to ignore VSCode’s .vscode file, just in case anyone else who wanted to contribute that uses VSCode doesn’t have to worry about the .vscode file3
*Todo: Add description*
>Last commit: a year ago
>Last commit on readme: 5 years ago
Slothful cunt, you don't deserve these 7 stars
If it hasn't a README, its not opensource! Just because you put it on Github doesn't mean people can use it...5
Co-worker put up a pull-request for his work, with no build file, no readme, no gitignore, and shell scripts for running the app (but not compiling it). O_o
The guy has been using atom editor even though we have license for Intellij for everyone, which .. whatever .. if it works for you...
In our daily stand, people offered to help him add the build files and he was like, "No, I know how to do it, I was just trying to avoid using Gradle until I had to."
It just made me think, "Yea I know you have all these nice screw drivers and hammers, but I'm going to keep using my hands and this stick so I can avoid using tools until I have to."
Good evening programmers, IT's, devranters and memeians.
I would like to use a little bit of your collective conciousness - the hive mind if you will.
I've been working on my automation system for quite a while and I've received some exposure from non-programmers - which resulted in more questions than suggestions.
I would like to ask you guys to give me some suggestions as to what I could add to my system.. that is, if you have time..
The program in short (if you don't want to read the readme file) is an automation system scriptable in pure Lua.
It utilizes Selenium for web automations, NAudio for audio operations and Moonsharp as an interpreter.
While my tester friends say that they use it for the actual testing, I myself found it very useful in writting bots (for browser games for example).
Here's the github link: https://bit.ly/2GDu92g
Thanks a ton!
PS. Here's an unrelated image to draw your attention.6
Recently I started coding a project for my school with two of my friends. The first one is a person which spends most of his time reading 4chan and joking about Pope, you know this kind of person. The second, Michael, is a really good partner for coding, he's just an opposite of Jedrzej, the first one. Jedrzej used to call people 'cancer' and this kind of sh**. Lately Michael said, that he's mother has breast cancer and he left our conversation on Facebook. Later I told Jedrzej, that he has to tell Michael 'sorry', but he wrote something stupid (doesn't matter what) and the situation only went wrong. At least I told them that they have to bury the hatchet and start working. The only problem here is that Michael and I made 99.7% of our project, Jedrzej only updated README and shared his VPS. I'm a full-stack dev, but our project is on laravel and I don't know what kind of sorcery is this framework so Michael does the back-end. My question to all of you who read this rant - what should I do with lazy Jedrzej?7
That feeling when you open link that's supposed to lead to the index of documentation and you find this...
The rest was.. unfinished..
Great how I’ve just started a new job, haven’t been given all the licenses I need to run the software, there are multiple products with little to no documentation (and by none I mean the word “Architecture” is all there is in one of the main products ReadMe file) and I’ve a year of this! How is a company that’s this big not in any way documented like! This is gonna be long 😑2
Was just asked to review a new set of libraries that the "experts" from our contracting wing created.
I opened one and the readme lists its features as:
- Feature 1
- Feature 2
- Feature 3
and the Faq is:
- Possible question 1
- Answer to question 1
EN: The Amazing work on this readme! The hours they must have spent!
ES: El trabajo increíble en este Readme. Las horas que habrán usado.4
Stop giving your little utilities stupid, esoteric names. You clearly can’t be trusted to include even the most basic readme with your software that explains what it is actually for, so you don’t get to be creative with your naming.
If you cannot be bothered to apply a little bit of common-sense, you need to name your software to reflect exactly what it does.2
I worked directly in my Github repo folder while working on a project (don't ask me why). I did my initial commit with all my code from the start until 5 hours ago. I never pushed.. A minute ago, I checked my commit and noticed that there were DB credentials in one of the files. So.. Smart me.. "revert commit"..
Result. Everything got deleted except my node_modules folder and the readme file.. I lost everything.. Fuck me, I'm going home..
Please, someone.. Can I get these files back via git or something? Can't find anything in in the history..10
So, i'm trying to get linkr (a pretty cool short link service) to work in a docker container since 4 hours now to host it on my server. There is no official container because it needs a working database connection and stuff during installation which can only be done via console and (for whatever reason I couldn't find out yet) need to be done while building the container. The problem is, I can't connect it to the database while building the container so there is no database during installation to create tables and stuff and the build will fail. ARGH.
Why the hell would you do this????? Theyre actually saying in their readme there is no dockerfile because the config options are specific to your configuration...?!?!
The thing is entirely written in python, so reading and parsing configfiles on the fly should not really be a problem.
Of course I could ssh into the container and run the installation script but that's not the point.
Docker is not about being lazy.
It's about portability.
Maybe I don't want to bloat my server with your 39579372639 npm dependencies? Or I don't want to install a freakin apache, because I have every other site on nginx and therefore wouldn't work with apache.
in the end, I'm probably going to modify the thing to install tables when running the container and giving the first user admin rights instead of prompting to enter credentials for a new admin user.
And yet I didn't even speak python.
Today I wrote my first plugin ifor elasticsearch ... Was awsome feeling..it is cool to decorate the readme when you have written something of your own.2
When you commit a more readable README on GitHub to a non native English speaker sends you an email a day later asking for help why his self-signed certificate isn't trusted by his browser or his other computers.
The project he's working on is to sniff Wi-Fi packets that are encrypted through a MiTM attack. I've now stopped following this project and moved on.
Has anyone else had any stupid questions from debs which were about the key purpose of their project and how to go about it?
Providing a nice Readme.md file with your open source project is never enough. You need to have a beautifully designed website for the documentation to go with it, oh yes sir!1
Learn Basics of Git and Github
Get things set up with Git and GitHub
Set up Git locally
a. Download and install Git (http://git-scm.com/downloads)
b. If not in Linux, open git terminal (Git Bash). In Linux, it just works.
c. Configure your username and email:
git config --global user.name <your user name>
git config --global user.email <your email address>
Sign up for Github account (https://github.com)
I would suggest registering using the email you used in your Git configuration above.
Do it up locally
In your project folder, make a .gitignore file that has the names of things you don't want to be version controlled (e.g., docx, *exe, pycache folders, and anything else you want hidden).
cd to your project folder, and enter git init. You know have a local GitHub repository. You pretty much are done.
git status to see what's up.
git add . to add everything to the staging area.
git commit -m "my first commit!" to commit to the repository
Now work on your project locally. When you have something cool, then commit it with commands 4 and 5. You are using git. Use git status to see what's going on in your repository.
Do it up remotely
At GitHub, point and click and such to create the repository with project name that you want (e.g., foo). The URL of the repository will be provided to you (e.g., https://github.com/yourname/foo.git).
Connect your local repository to the remote one using that URL you just got. At your terminal:
git remote add origin https://github.com/yourname/foo.git
Push your local repository to GitHub:
git push origin master
It will ask you for your remote username and password.
And now, whenever you have finished working on your local machine, just enter that same command from step 3 and your work will be pushed to GitHub!
There, you've done it. Go check out your repository at GitHub. Share it. Pat yourself on the back for a sec. Now, get to work and write that code! Maybe add a readme file to your project, so people will be able to read about it: GitHub will show it automatically for you. The above is 99% of what I do with my little one-person projects. Once you hit a snag or need more information about more complicated stuff, you will be able to get it at stack overflow or google or via a book.2
Ugh. Where to begin!
If you gotta make a standard for everyone to follow, you better make it readily available. Even though you barely have any users, but if it's a standard, anyone can try to follow it tomorrow. Or else take it down completely.
There's a standard for learning tools handled by IMSGlobal (Don't ask who they are, no idea). So if you want to build a tool to integrate with different learning platforms, follow this.
OK now, to read the documentation you have to register for an account. As if this is bad, ....... wait for it ........, sign up has to be approved by an admin. My request is already weeks old but not approved.
OK. Google around and try to see if some alternative can be read than that shitty website. Apparently, they have a Spring plugin on GitHub that can be used as a Maven dependency. It has a small readMe attached so I can get something out of it.
And I'm using Spring, golden right? Not quite...............
turns out the stupid readMe is outdated. If you follow those instructions, you get errors. WONDERFUL!!
Now I have to dig through all the code files and try to make sense of what I'm supposed to do.
Hey where can I get access to the devrant API? GitHub readme said it isn't officially public yet but people are still using it. Just had a few for projects I wanted to try.2
Finally found some time to write readme for my project "selector". You can check it out. And of course contribute if you want to. https://github.com/lamka02sk/...
I thought the ReadMe file on git was for how to use someone's source code. why I find most of them empty!! 👊 😉 others jst have -----###2
I asked my co-worker/classmate to integrate a react component into a project "we" worked for the (forced) practicum. I searched and setup the example with him (or rather for him) to check whether it's working as intended.
Note, that we were both not really familiar with react and or node. I had a bit more experience and would have helped him, if he had asked. IF
I asked him regularly how he's progressing and he said he did fine. 3 days later I finished my tasks and wanted to know how far he got.
Status? Non working example project because all he did was commenting out seemingly random lines all over the only file in the example project one had to copy paste from the Readme.
Here is my GitHub repository where I demonstrated
1. Role Based Authentication with fake jwt and mocked backend.
2. Lazy loading and eager loading modules.
3. Data Resolvers.
4. A pretty good project structure.
Each different topic is implemented in a different branch. I just wanted to share it here.
I have also provided links to the online resources where I learned or practiced these things in Angular ( Check Readme file for more info) :)
Feel free to check.
Considering that Markdown exists and Readme files are rendered by default in GitLab, Github, and so on
Why devs insist on documenting stuff on Confluence?14
README.md, is there any way in bitbucket/stash to customize the index markdown to be rendered other than README.md?2
During a training reading a Readme file:
Copy paste the following code in the editor.
NOTE: REPLACE ALL SPACES WITH TABS OR IT WILL BREAK
My first public github Repository:
Kubernetes on RaspberryPi4 based on Manjaro ARM64
I am a little bit proud. Even if the Readme is not yet finished and rook.io (ceph) has to be added.2
How can I make a bot which makes a single commit everyday at a specific time for a particular repository?
The commit can be anything like insertion in readme or creating a new file.
I tried to accomplish this using python selenium I deployed it on heroku, the problem I am facing is github doesn't allows to crawl on it so it sends a verification code to me on mail and all my further selenium actions fail due it this.☹️26
Don't you love it when a module maintainer replay for install instruction is "If there any specific things you think should be improved in the README or the help, please file a patch :)" What a dumb fuck you have to be to act that way??2
Is this me or web developers never ever document their library?
I'm coming from the mobile dev world ans from what I've seen so far 8/10 mobile librairies got a well documented readme with some examples, etc.
I'am looking for web (php) librairies and no one give a fuck explaining what its shity library do and I never ever saw librairies with screenshots or gifs to give some examples...
I WON'T DOWLONAD YOUR SHITTY LIBRARY IF I DON'T EVEN KNOW WHAT IT DOES...1
Am I the only one that cringes when they see the word "scale" mentioned on a software product's documentation/README?