Comments (8)
I think it is better to close the issue for now. I had some other ideas but most of them are too raw, halfbaked and generally disorganized that I can write them down.
I might reopen it later and or directly send a PR once I got it sorted.
from module-5-open-research-software-and-open-source.
I think that this is a good point. In addition, the README is the first impression that you make and it is a kind of light-weight documentation artifact. I found some examples of how to structure READMEs here: https://github.com/matiassingers/awesome-readme#tools
from module-5-open-research-software-and-open-source.
That's a good idea! Do you mean things like good README files? We have a bit of that in the first Task, but it could perhaps be expanded on there?
from module-5-open-research-software-and-open-source.
I've already included some information here on how to write a good README file. But please do expand on it if you think it can be improved! @Remi-Gau @schlauch :)
from module-5-open-research-software-and-open-source.
Pinging @Remi-Gau and @schlauch - do you think this is okay for now, so I can close this issue, or still room for improvement? :)
from module-5-open-research-software-and-open-source.
Yes, I think that task 1 already does a good Job explaining the basic aspects :)
from module-5-open-research-software-and-open-source.
OK, will wait for @Remi-Gau to have a look before closing this - thank you!!
from module-5-open-research-software-and-open-source.
OK, sweet, thanks @Remi-Gau! Would be sweet to get back on this as your thoughts develop, but I think we at least have the basics covered for now :)
from module-5-open-research-software-and-open-source.
Related Issues (20)
- External Links HOT 1
- mention alternative to github-zenodo HOT 5
- Links and images not converting correctly HOT 8
- Add in to next release
- Design a quiz HOT 26
- Design screencast recordings HOT 13
- Cover research software HOT 20
- New task: Linking Git and GitHub with R HOT 9
- GETTING REPRODUCIBLE , from nature blog, food for thoughts? HOT 4
- Repo metadata HOT 16
- Add GitLab option in HOT 1
- quizz HOT 20
- expand content to talk about code HOT 7
- hyperlinks need to be corrected HOT 7
- how to contribute to existing open source research projects HOT 1
- https://openmoocers-slackin.herokuapp.com/ link broken HOT 6
- broken link on eliademy.com HOT 1
- Incorrect description of OSS vs. free/libre software HOT 3
- Add the titles of articles in Reading material folder. HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from module-5-open-research-software-and-open-source.