-
Notifications
You must be signed in to change notification settings - Fork 136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Seperate Code from README.MD #142
Comments
I couldn't agree more... |
@arunisaac @indrajithi Agreed! The problem being that Github doesn't allow file inclusion in its Markdown. That would have made everything so much easier. Any alternatives? I can only think of Duplication. |
@KarthikNayak : You have done an excellent work by putting this work on github with screenshots. What will make it more awesome is when you adapt some style like most repository in Github. |
@indrajithi First off, The repo is not mine, it belongs to FSMK, so all credit goes to the team. I'm just one of the maintainers :) Having a Makefile to compile
So I'm trying to see if we could come up with a nice scheme to have source code directly accessible while keeping the documentation as it it. |
I'd say, have multiple files, like 5a.md and 5a.c (or) 5a.cpp now we can write explanation on markdown, and maybe can generate documentation if we use correct format while writing comments. Now we can anyway link it to part of a file which is well supported in Github, we can always have a little bit of snippets here and there, which shouldn't be a problem :) |
Instead of putting the code in README it is better to keep the code in separate
.c or .cpp
file and all the documentation in README. So we can clone the repository and just compile and run the code without any hassle.The text was updated successfully, but these errors were encountered: