Merge pull request #3 from pedsm/dev

The writter update
pedsm · Jan 10, 2017 · 5396988 · 5396988
2 parents a1efb69 + fcc1ac8
commit 5396988
Show file tree

Hide file tree

Showing 6 changed files with 802 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 *.swp
+*.swo
 /testFiles/
 tags
diff --git a/README.html b/README.html
@@ -0,0 +1,99 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Style-Type" content="text/css" />
+  <meta name="generator" content="pandoc" />
+  <title></title>
+  <style type="text/css">code{white-space: pre;}</style>
+  <link rel="stylesheet" href="/home/pedro/.vim/bundle/sprint/assets/github.css" type="text/css" />
+</head>
+<body>
+<h1 id="sprint-2.0">Sprint 2.0</h1>
+<p>Async file running</p>
+<div class="figure">
+<img src="doc/pic1.png" alt="Screenshot" />
+<p class="caption">Screenshot</p>
+</div>
+<h2 id="tldr">tl;dr</h2>
+<p>Just like any IDE’s run button this plugins just runs your code.</p>
+<h2 id="dependencies">Dependencies</h2>
+<p>Sprint relies heavily on <span class="citation">@skywind3000</span> <a href="https://github.com/skywind3000/asyncrun.vim">async run</a>, sprint also relies on Vim 8.0’s async functionality. Depending on what language is being used with Sprint you will require a different dependecy check the supported languages area for reference.</p>
+<ul>
+<li>Async run</li>
+<li>Vim 8.0</li>
+<li>Language compilers/interpreters</li>
+</ul>
+<h2 id="what-does-it-do">What does it do?</h2>
+<p>Sprint adds a command to vim to allow for asynchronous running of your file, perfect for testing. On compiled formats sprint will compile to the defautl name or use the “sprintFile” name to create a file to run, so make sure no file with this name exists.</p>
+<h2 id="supported-languages-and-language-dependencies">Supported languages and language dependencies</h2>
+<table>
+<thead>
+<tr class="header">
+<th align="left">Languages</th>
+<th align="left">Compiler</th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td align="left">C</td>
+<td align="left">GCC</td>
+</tr>
+<tr class="even">
+<td align="left">C++</td>
+<td align="left">G++</td>
+</tr>
+<tr class="odd">
+<td align="left">Python</td>
+<td align="left">python</td>
+</tr>
+<tr class="even">
+<td align="left">Php</td>
+<td align="left">php</td>
+</tr>
+<tr class="odd">
+<td align="left">Javascript</td>
+<td align="left">node</td>
+</tr>
+<tr class="even">
+<td align="left">Coffee Script</td>
+<td align="left">coffee</td>
+</tr>
+<tr class="odd">
+<td align="left">Haskell</td>
+<td align="left">ghc</td>
+</tr>
+<tr class="even">
+<td align="left">Latex</td>
+<td align="left">pdflatex</td>
+</tr>
+<tr class="odd">
+<td align="left">Markdown</td>
+<td align="left">pandoc(pdf)</td>
+</tr>
+<tr class="even">
+<td align="left">README.md</td>
+<td align="left">pandoc(github styling)</td>
+</tr>
+</tbody>
+</table>
+<h3 id="things-to-consider">Things to consider</h3>
+<p>In order to compile the contents of the buffer Sprint must save your files before executing. However after executing the file Sprint will delete the file.(Sprint is for quick testing not for final release builds, makefiles are your friend)</p>
+<h2 id="installing">Installing</h2>
+<p>Use any package manager of your liking if you have Vim 8.0 and Async run. My recommendation is to use vundle with the following code.</p>
+<pre class="viml"><code>&quot;This checks for vim 8.0 or above before installing plugins
+if v:version &gt;= 800
+    Plugin &#39;skywind3000/asyncrun.vim&#39;
+    Plugin &#39;pedsm/sprint&#39;
+endif</code></pre>
+<h2 id="using">Using</h2>
+<p>Sprint is simple just run :Sprint at any file of the supported languages and watch the result.</p>
+<h2 id="customizing">Customizing</h2>
+<p>If you want Sprints to override running programs(Ideal for programs that run for a long time you can set the following variables on your vimrc.</p>
+<pre class="viml"><code>    let g:SprintForceRun = 1</code></pre>
+<p>If you want Sprint not to open the quickfix window and you rather open it manually add the folling to your vimrc</p>
+<pre class="viml"><code>    let g:SprintHidden = 1</code></pre>
+<h4 id="to-do">To-do</h4>
+<p>Pull requests are helpful and the code base is small - [ ] Add more languages - [x] Global variables for copen - [ ] Global variables for cw - [ ] Global variable for writing the file - [x] Global variable for override running process - [x] Finish the help help file - [ ] Add buffer mode</p>
+</body>
+</html>
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# Sprint
+# Sprint 2.0
 Async file running
 
-
 ![Screenshot](doc/pic1.png)
+
 ## tl;dr
 Just like any IDE's run button this plugins just runs your code.
 
@@ -25,7 +25,11 @@ Sprint adds a command to vim to allow for asynchronous running of your file, per
 |Python     |python   |
 |Php        |php      |
 |Javascript |node     |
+|Coffee Script |coffee     |
 |Haskell    |ghc      |
+|Latex      |pdflatex |
+|Markdown   |pandoc(pdf)|
+|README.md  |pandoc(github styling)|
 
 ### Things to consider
 In order to compile the contents of the buffer Sprint must save your files before executing. However after executing the file Sprint will delete the file.(Sprint is for quick testing not for final release builds, makefiles are your friend)