X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=README.md;h=7068851fce9ff93f855ad1300b2b7278a012dc7a;hb=fbbdcc3d78e510394dfd87e66b9512828b563899;hp=4c9754f5e7ba077baae1010d191743dcab657832;hpb=0260938e8ee893954f4b6e142132bad4d0374d60;p=chaz%2Fvimcoder diff --git a/README.md b/README.md index 4c9754f..7068851 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,8 @@ It aims to be minimal in comparison to other editors such as [CodeProcessor](http://www.topcoder.com/tc?module=Static&d1=applet&d2=plugins) plug-in chains while also providing enough functionality to also be useful. -### Features +Features +-------- * Works on any platform that the TopCoder Arena applet itself supports. * Works with any language supported by TopCoder. @@ -23,19 +24,22 @@ plug-in chains while also providing enough functionality to also be useful. * Test-case "drivers" can be generated locally with the example test-case data (currently C++ only). -### License +License +------- This software is licensed according to the terms and conditions of the [BSD 2-Clause License](http://www.opensource.org/licenses/bsd-license.php). Please see the COPYING file for more information. This project is neither supported nor endorsed by TopCoder, Inc. -### Download +Download +-------- -The latest VimCoder jar files can be downloaded from -[this FTP server](ftp://ftp.brokenzipper.com/pub/vimcoder/). +The latest VimCoder jar file can be downloaded from the +[vim.org script page](http://www.vim.org/scripts/script.php?script_id=3321). -### Install +Install +------- Unfortunately, installation is a bit cumbersome, but it is what it is: @@ -55,7 +59,8 @@ You should now be able select "Vim" (or whatever you entered the first field) as your editor from the pull-down list on any problem statement window. -### Configure +Configure +--------- Depending on your preference or system attributes, you may want or need to first configure the plug-in so that it will work how you want it to. You can @@ -106,7 +111,8 @@ command when it is invoked. After changing this value and saving your preferences, the command you enter will be used the next time you open a problem. -### Usage +Usage +----- To use VimCoder once it is installed and configured, go to a room in the TopCoder Arena applet and open one of the problems. If you have set VimCoder @@ -117,13 +123,14 @@ will see that the area usually devoted to editor will be used for log messages; you will do your actual coding in the Vim window that comes up. Just enter your code into the Vim window and use the regular TopCoder Arena -applet buttons to compiled, test, and submit your code. +applet buttons to compile, test, and submit your code. **Pro Tip:** If you accidentally close your Vim session, you can get it back -by switching to a different editor and then switching back to VimCoder +by switching to a different editor and then switching back to VimCoder. Alternatively, the session will also reappear if you switch languages. -### Problem and Solution Files +Storage Directory Structure +--------------------------- Knowing about the files created by VimCoder is useful if you ever need to do anything advanced with VimCoder. @@ -150,11 +157,11 @@ for your solution. This file contains the example test cases that are associated with the problem. The format is pretty simple. For each test case, there is one line for the expected return value followed by each of the method parameters, each -on its own line. This file typically read by the driver program (more on this -later) in order to run the test cases against your code. While you are coding -a solution, you may also want to add additional test cases to make sure your -code is doing what you think it is and to make sure your code doesn't mess up -on edge cases for which an example test case was not provided. +on its own line. This file is typically read by the driver program (more on +this later) in order to run the test cases against your code. While you are +coding a solution, you may also want to add additional test cases to make sure +your code is doing what you think it is and to make sure your code doesn't +mess up on edge cases for which an example test case was not provided. ##### Problem.html @@ -167,10 +174,10 @@ typically shouldn't edit this file. If there exists a Makefile template for the selected language, it will also be filled out and saved in the problem directory. The purpose of the Makefile is -to compile your code locally. Vim contains the command :make which you can -use to interact with the Makefile. You also shouldn't need to edit this file -directly. Exactly what happens when you use the :make command depends on the -Makefile template. +to compile your code locally. You can execute targets in the Makefile using +Vim's `:make` command. You also shouldn't need to edit this file directly. +Exactly what happens when you use the `:make` command depends on the Makefile +template. If you are using the default Makefile template for C++, typing ":make" without any arguments will compile your code. Typing ":make run" will run all of the @@ -214,7 +221,8 @@ extension. You can open this file if you need to access this code for any reason (say, you messed up some code and need to revert back to the last time you saved from the TopCoder Arena applet). -### Templates +Templates +--------- VimCoder comes with default templates for C++ and Java, but you can create your own customized templates for any language supported by TopCoder. To use @@ -317,7 +325,8 @@ public class $CLASSNAME$ { Something like this should be saved in a filed named `JavaTemplate` in your VimCoder storage directory. -### Gotchas +Potential Pitfalls +------------------ ##### Vim Client/Server