add basic tests

[chaz/vimcoder] / README.md

diff --git a/README.md b/README.md
index fff2d036598a7aa61b5adee3336f94ecbb956884..5cebe0ccdf7d7beed7252fda44643356a5600b54 100644 (file)
--- a/README.md
+++ b/README.md
@@ -24,6 +24,11 @@ Features
 * Test-case "drivers" can be generated locally with the example test-case data
   (currently C++ only).
 
+Build Status
+------------
+
+[![Build Status](https://travis-ci.org/chazmcgarvey/vimcoder.svg?branch=master)](https://travis-ci.org/chazmcgarvey/vimcoder)
+
 License
 -------
 
@@ -87,6 +92,21 @@ use.  If you have already saved some problems to the previous storage
 directory, you may also want to actually move the directory to the new
 location so that VimCoder can find the work you've already done.
 
+Beginning with VimCoder 0.3.5, there is a new option for an alternative
+directory structure.  It is not enabled by default, but it may be in the
+future.  Rather than having directories named after problem identifiers, the
+new structure uses two levels of directories.  On the first level, directories
+are named after the contest associated with the problem (e.g. SRM-144-DIV-1),
+and on the second level, directories are named after the problem's point value
+(e.g. 300).  This directory structure may be preferable if you ever want to
+browse your repository since the contest name and point values are more easily
+identifiable than the problem identifier.
+
+If this new directory structure is enabled, it will only apply to new
+problems.  VimCoder will not try to reorganize your current repository, though
+you are welcome to do it manually yourself if you would like to switch to the
+new directory structure.
+
 ##### Vim Command
 
 By default, VimCoder tries to invoke Vim using the `gvim` command (or
@@ -101,7 +121,7 @@ to something else.
 You may use an absolute path to your vim executable, such as
 `/usr/local/bin/gvim` or `C:\Program Files\Vim\vim73\gvim.exe`
 or wherever your actual Vim executable is.  You may also invoke vim through
-some other command (e.g. `xterm -e vim`).
+some other command (e.g. `xterm -e vim` or `gnome-terminal -e vim --`).
 
 The xterm example above demonstrates using Vim without the GUI, running in
 a terminal emulator.  You can enter any elaborate command you want as long as