aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCody Hiar <codyfh@gmail.com>2018-03-29 10:32:19 -0600
committerCody Hiar <codyfh@gmail.com>2018-03-29 10:32:19 -0600
commitbd2fdc1372be3d11c8205b6ef2965d4173cf53f0 (patch)
tree8f976c36ed90f5ccb9882ab20f61644b39ca6196
parentc4e32712d5c9826a9a3d9a91ea974b276bb9911a (diff)
Updating README with hard indents
-rw-r--r--README.md50
1 files changed, 31 insertions, 19 deletions
diff --git a/README.md b/README.md
index fab51fe..719ef30 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,38 @@
# Dockerized Neovim
-Run neovim in a container and be cool like all the other cool kids.
-I'm currently trying to have as little dependancies installed on my host machine as possible.
+
+Run neovim in a container and be cool like all the other cool kids. I'm
+currently trying to have as little dependancies installed on my host
+machine as possible.
# Step 1: Build the image
-The are 2 small steps that occur in this step.
-First we build the binaries for shellcheck, because I want to only have couple of MB's in binaries vs installing haskell.
-This creates a folder called 'package' at the root directory which we then import to our main neovim image.
-The second step is actually compiling the the neovim package which is just installing some stuff and copying the binaries.
-This can all be done with a single make command.
-```
-$ make build
-```
+
+The are 2 small steps that occur in this step. First we build the binaries
+for shellcheck, because I want to only have couple of MB's in binaries vs
+installing haskell. This creates a folder called 'package' at the root
+directory which we then import to our main neovim image. The second step
+is actually compiling the the neovim package which is just installing some
+stuff and copying the binaries. This can all be done with a single make
+command `make build`
# Step 2: Run the image
-Say you have a local file called 'test.php' and you are in the same directory as the file.
-To open that file with the neovim container simply run the following
+
+Say you have a local file called 'test.php' and you are in the same
+directory as the file. To open that file with the neovim container simply
+run the following
+
+
```
$ docker run -i -t -v $(pwd):/src thornycrackers/neovim /bin/sh -c 'nvim /src/test.php'
```
+
This will open up neovim and when you exit neovim it will exit the container.
# Step 3: Make this command a little more useful
-So using that command is awesome but a little cumbersome everytime you want to run it against a different file.
-Create a file called 'nvim' and make sure to give it executable permissions and place it somewhere in your $PATH.
-Copy the following inside of the 'nvim' executable file.
+
+So using that command is awesome but a little cumbersome everytime you
+want to run it against a different file. Create a file called 'nvim' and
+make sure to give it executable permissions and place it somewhere in your
+$PATH. Copy the following inside of the 'nvim' executable file.
```
#!/bin/bash
@@ -41,9 +50,12 @@ fi
docker run -i -t -P -v "$dir_name":/src thornycrackers/neovim /bin/sh -c "cd /src;nvim $file_name"
```
-Now you can run neovim as if you would regularly.
-The only gotcha I've deiscovered so far is that because you are mounting to the docker container you cannot go above the folder you open neovim in.
-This is a pretty rare case in my trials of using this but it is something to note.
+Now you can run neovim as if you would regularly. The only gotcha I've
+deiscovered so far is that because you are mounting to the docker
+container you cannot go above the folder you open neovim in. This is
+a pretty rare case in my trials of using this but it is something to note.
## NOTE:
-I do set the git identity to myself inside the Dockerfile so do be aware that you might want to change it to yourself.
+
+I do set the git identity to myself inside the Dockerfile so do be aware
+that you might want to change it to yourself.