Dogcows Code - chaz/vimcoder/blob - README

   1
   2 VimCoder
   3 --------
   4
   5 The TopCoder Arena editor plug-in providing support for Vim.
   6
   7 The version is very experimental, and I haven't gotten around to writing
   8 any substantial documentation.  It is also not very configurable without
   9 changing the code.  All of these problems will be remedied eventually.
  10
  11
  12 Features:
  13
  14 - Use Vim to edit your TopCoder Arena problems!
  15 - Keeps track of code files locally and syncs with the server, so no more
  16   copy and pasting to and from the Arena applet.
  17 - Works with any language.
  18 - Downloads and stores a copy of the problem statement with your code for
  19   off-line viewing.
  20 - Basic support for templates (currently C++ only).
  21 - Local test-case drivers can be automatically created with the example
  22   test-case data (currently C++ only, and has bugs).
  23
  24
  25 Compatibility:
  26
  27 I've tested the plug-in only on my own computer which runs x86_64 Linux.
  28 It should work on other setups, but note the following:
  29
  30 - The program "gvim" should be in your PATH.
  31 - Vim needs to be compiled with client/server support.  To check, make sure
  32   the command "vim --version | grep +clientserver" prints something.
  33 - The test-case driver generated for C++ uses POSIX functions for timing,
  34   so it may not compile on non-POSIX systems (i.e. Windows).  The C++Driver
  35   template simply needs to be changed to support other timing functions.
  36
  37
  38 How To Install:
  39
  40 Assuming you have the downloaded the VimCoder jar file:
  41
  42 - Run the TopCoder Arena applet.
  43 - Click the "Options" menu and select "Editor" to show the editor
  44   preferences.
  45 - Click the "Add" button to bring up a new window.
  46 - For "Name," type "Vim" or whatever you want to represent this plug-in.
  47 - For "EntryPoint," type "com.dogcows.VimCoder" without the quotes.
  48 - For "ClassPath," click on "Browse" and locate the VimCoder jar file.  The
  49   third field should now have the path to the jar file.
  50 - Click "OK" to close the window with the three fields.
  51 - Click "Save."
  52
  53 You should now be able select "Vim" (or whatever you entered the first
  54 field) to use the plug-in.  If it doesn't work (i.e. nothing happens), you
  55 may need to restart the applet or set the plug-in as the default editor.
  56 Your mileage may vary.
  57
  58
  59 Known Bugs:
  60
  61 - Lack of documentation.  The code itself is also poorly documented.
  62 - Only C++ templates are provided.
  63 - The generated C++ driver code won't compile when the method has one or
  64   more parameters that are vectors (i.e. vectors of strings).
  65 - The $CARAT$ token doesn't seem to work in the templates.
  66 - Directory where code and problem data is saved is hardcoded at
  67   ~/.vimcoder.  This should be configurable.
  68