Organized, a few details added in competitive #5

diveshuttam · 2017-09-21T14:07:13Z

No description provided.

sharmaeklavya2 · 2017-09-22T04:44:18Z

Thanks for working on this.

However, I see several issues with your pull request. I think you should have talked to me before beginning work on it. But don't worry, we'll improve your pull request. You also have too many commits. I was expecting around 5 to 10 commits. I'll shortly begin review. After you fix all issues I point out, squash your commits into a few meaningful commits.

sharmaeklavya2 · 2017-09-22T04:48:38Z

Your pull request also seems incomplete, as can be seen in intro.md where you have included headings like backend, competitive, linux, etc. but you haven't given any links to them.

I have no problem with you trying to do everything in a single pull request, but usually people split their work across various pull requests depending on the type of work and submit them one by one. You could have, for example, submitted work on competitive programming in one pull request, work on organizing tools, adding license, etc. in another pull request.

sharmaeklavya2 · 2017-09-22T04:54:00Z

I don't think we need a verbatim copy of a license in a LICENSE file. Just stating the licenses in readme.md and linking to them seems enough to me. Also, the license you have included is GPLv3, while we currently don't have any code which can be covered by it. I suggest you remove the LICENSE file.

sharmaeklavya2 · 2017-09-22T04:58:52Z

All file and directory names should be lowercase and hyphen-separated.
So for example, Competitive Programming should be changed to competitive-programming.

This is needed because these file and folder names will be part of URLs and it is a best practice to keep URL names lowercase (so that they are easily memorizable). URLs shouldn't have spaces between them, otherwise we'll have to use ugly %20s everywhere. Underscores are okay for URLs but they cause trouble when writing URLs in markdown, so avoid underscores as well.

sharmaeklavya2 · 2017-09-22T05:07:51Z

I'm not convinced that we need a TC to GCC porting guide. We should just tell them that TC is not standards-compliant and they should look at code written for GCC to find out what all changes do they need. There aren't many changes except those related to IO and standard libraries, and people should look up docs for them anyways (because they have a lot of important information), whether they used TC previously or not.

I too used non-standard C++ (Visual C++ 1998) in school, but switching was easy once I looked at one or two GCC-targeted programs.

sharmaeklavya2 · 2017-09-22T07:41:05Z

I'm sorry to say that you have done a bad job at writing English. Your sentences have many grammatical and typographical errors. You have not used or incorrectly used punctuation. Your sentences are sometimes too long and need to be split. Please be vigilant and avoid making such mistakes in the future. I'm not just referring to these articles, but anything you write in the future.

sharmaeklavya2

I have completed my review. Reviewing took a lot of time, since you had a lot of new material and there are lot of issues to be addressed. It's great that you took out the time to write a C to C++ porting guide.

I think you are a bit verbose. I'm not sure whether what you have written can be written in lesser words, but try to do it if possible.

Please take care of your spelling and grammar. Before sending any pull requests, do a critical proofreading to ensure that no mistakes have crept in.

If you disagree with anything I have said, feel free to mention it and we'll discuss what the right solution can be.

I didn't check, but if you have written parts of the article in a personal tone (like using words like 'I', 'me', etc.) please mention yourself as the author in the beginning of the article.

sharmaeklavya2 · 2017-09-22T05:15:02Z

Competitive Programming/CP1.md

@@ -30,10 +30,12 @@ If you know only C, you can easily start.
 But at some point of time (especially when you reach advanced stages),
 you'll need features which most languages have but C does not.
 Learning C++ is very easy if you know C.
-If you already know C, you should start competitive programming in C and learn C++ in parallel.
+If you already know C, you should start competitive programming in C and learn C++ in parallel. You may refer to [C to C++ for Competetive](c2cpp.md) after you solve [a few basic problems](#making-the-first-step) for a brief intro and resources .


I think it should be changed to

You may refer to C to C++ for Competitive Programming for a brief intro and resources after you solve a few basic problems using C.

Also, avoid using too long lines in markdown. This sentence should come in the next line and not in the same line as 'If you already know C, ...'.

sharmaeklavya2 · 2017-09-22T05:18:15Z

Competitive Programming/CP1.md

-Competitive programming is also a good way to practice a new language you have learned.
+Competitive programming is also a good way to practice a new language you have learned.  
+
+If you have no prior knowledge you can begin with [CS50 2016](http://cs50.tv/2016/fall/) (week 0 to week 5) (it teaches c which anyways is useful as its part of BITS Curriculum)  


s/its/it's (It means replace its by it's).
s/it teaches c which anyways is useful/it teaches C, which is anyways useful
s/Curriculum/curriculum

Split sentence into multiple lines. Preferably less than 80 to 100 characters per line.

sharmaeklavya2 · 2017-09-22T06:33:10Z

Competitive Programming/CP1.md

@@ -78,7 +80,9 @@ If you have never before solved a problems on an online judge, you can begin by
 the easiest problem on Codechef - [Life, the Universe, and Everything](https://www.codechef.com/problems/TEST).
 You will have to read the [Input/Output tutorial](http://blog.codechef.com/2009/02/24/54/) to solve the problem.
 If you face problems, you can refer to [Eklavya's solutions](https://www.codechef.com/status/TEST,sharmaeklavya2).
-He has submitted code in many languages, so you'll most likely find a solution in the language of your choice.
+He has submitted code in many languages, so you'll most likely find a solution in the language of your choice.  
+Also codechef has [screencasts](https://www.youtube.com/playlist?list=PLi0ZM-RCX5ntfqwXRirwA_pcufHinjllG) explaining this problem in c,c++ and java  


s/Also/Also,

Split sentence into multiple lines.

s/c,c++ and java/C, C++ and Java.
Use title-case for language names.
Always end a sentence with a full stop.
Add a space after a comma.

sharmaeklavya2 · 2017-09-22T06:38:25Z

Competitive Programming/CP1.md

-He has submitted code in many languages, so you'll most likely find a solution in the language of your choice.
+He has submitted code in many languages, so you'll most likely find a solution in the language of your choice.  
+Also codechef has [screencasts](https://www.youtube.com/playlist?list=PLi0ZM-RCX5ntfqwXRirwA_pcufHinjllG) explaining this problem in c,c++ and java  
+After this you can move on to more problems from [codechef beginner section](https://www.codechef.com/problems/school?sort_by=SuccessfulSubmission&sorting_order=desc) these problems mostly require only basic knowledge of programming(arrays, strings, loops) and math/logic. The ones with the code like FLOW??? are particularly very easy and can help you get aquainted with submissions on online judges.


Make this line a new paragraph and split it into multiple lines.

s/) these problems/). These problems
s/programming(arrays/programming (arrays

What is FLOW????

sharmaeklavya2 · 2017-09-22T06:40:23Z

Competitive Programming/CP1.md

@@ -130,12 +134,12 @@ and he got AIR 7 in a Codechef Long challenge!

 ## Compiler

-One frequently asked question is what compiler or IDE to use.
+One frequently asked question is what [compiler or IDE](#diff) to use.


What does #diff link to?

sharmaeklavya2 · 2017-09-22T07:30:10Z

Competitive Programming/c2cpp.md

+
+int main()
+{
+int t;


Please indent your code.

sharmaeklavya2 · 2017-09-22T07:30:52Z

Competitive Programming/c2cpp.md

+return 0;
+}
+```
+To compile this program on linux use `gcc --std=c++11 filename.cpp -o example` to run use `./example`. For codeblocks use build and run in build menu.


s/build and run/'build and run'

sharmaeklavya2 · 2017-09-22T07:33:04Z

Competitive Programming/c2cpp.md

+}
+```
+
+the line cin>>a>>b>>c; is es exactly same as cin>>a; cin>>b; cin>>c; this is known as cascading of `>>` operator similarly we have the next line where `<<` operator is cascaded.


Surround in-line code by backticks.

sharmaeklavya2 · 2017-09-22T07:34:49Z

Competitive Programming/c2cpp.md

+To compile this program on linux use `gcc --std=c++11 filename.cpp -o example` to run use `./example`. For codeblocks use build and run in build menu.
+
+# NEW in CPP (useful for competitive)
+## easier IO (cin and cout)


Do you know about C++ IO being slower? I think it's worth mentioning that, since beginners will have no idea why they're getting TLE otherwise.

sharmaeklavya2 · 2017-09-22T07:36:47Z

intro.md

@@ -0,0 +1,7 @@
+This file has an intro for various articles in this repository
+
+## Backend


I think you forgot to add links.

sharmaeklavya2 · 2017-09-22T14:37:21Z

When you want me to review it again, inform me by posting a comment on this thread.

diveshuttam · 2017-09-22T14:40:42Z

I am still working on this. Will update soon.

rename tools.md to tools1.md

minor changes in CP1.md

undoing certain unintended changes

diveshuttam · 2017-09-25T16:09:52Z

Thanks for a detailed review, I have tried to incorporate the suggested changes. I also need guidance in improving C to C++ guide. Please tell if you want any material to be added/ removed. I too feel that it is getting a bit comprehensive.

There has been a force push and it's difficult to track whether these issues were addressed or not.

sharmaeklavya2 · 2017-09-25T17:59:40Z

I think you should remove your second snippet and everything after that and before (but not including) the point about <iostream> being slow. That's because you don't need to give a detailed explanation about what <iostream> does. Just tell people that cin works like scanf and cout works like printf and your first snippet explains cin and couts interface, which is probably the only thing different between them and scanf/printf.

sharmaeklavya2

CP1.md looks good except for a few issues I have pointed out and that you should split long lines.

c2cpp.md still has long lines and occasional lexical issues, in addition to issues I have explicitly commented on.

sharmaeklavya2 · 2017-09-25T17:03:53Z

competitive-programming/CP1.md

@@ -31,10 +31,14 @@ But at some point of time (especially when you reach advanced stages),
 you'll need features which most languages have but C does not.
 Learning C++ is very easy if you know C.
 If you already know C, you should start competitive programming in C and learn C++ in parallel.
+> You may refer to [C to C++ for Competitive Programming](c2cpp.md) for a brief intro and resources after you solve [a few basic problems](#making-the-first-step) using C.


I think you should remove the > symbol from the beginning of the line.

Split this sentence into 2 lines.

sharmaeklavya2 · 2017-09-25T17:07:46Z

competitive-programming/CP1.md

@@ -135,14 +144,14 @@ One frequently asked question is what compiler or IDE to use.
 If you have Linux or Mac, it is best to use:

 * gcc for C
-* g++ for C++
-* javac for Java (both oracle and openjdk are good)
+* gcc/g++ for C++


Although it's possible to compile C++ code using gcc, it's much more convenient to use g++. I think you should change 'gcc/g++' to 'g++', since this article is aimed at beginners and we don't want to trouble/confuse them by making them try gcc to compile C++ code.

sharmaeklavya2 · 2017-09-25T17:17:34Z