From 9533c94b3fa8c120d2cee63c82c4133751922391 Mon Sep 17 00:00:00 2001
From: Ricardo Barbedo <ricardo@barbedo.me>
Date: Sun, 19 Nov 2017 15:09:10 +0100
Subject: [PATCH] Add instructions for Linux

---
 README.md | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index f3a6d77..6259a35 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,24 @@
 # vivado-git
 
-Trying to make Vivado more git-friendly on Windows.
+Trying to make Vivado more git-friendly.
 
 ### Requirements
 
+- Tested on Vivado 2017.3
+
+#### Windows
 - [Git for Windows](https://git-scm.com/download/win)
 - Add `C:\Program Files\Git\bin` (or wherever you have your `git.exe`) to your `PATH`
 
+#### Linux
+- Git
+
 ### Installation
 
-Add `Vivado_init.tcl` (or append the relevant lines if you already have something in it) along with the `scripts` directory to `%APPDATA%\Roaming\Xilinx\Vivado`.
+Add `Vivado_init.tcl` (or append the relevant lines if you already have something in it) along with the `scripts` directory to:
+
+- `%APPDATA%\Roaming\Xilinx\Vivado` on Windows
+- `~/.Xilinx/Vivado` on Linux
 
 ### How it works
 
@@ -21,9 +30,9 @@ Vivado is a pain in the ass to source control decently, so these scripts provide
 
 ### Workflow
 
- 1. When first starting with a project, create it in a folder called `vivado_proj` (e.g. `C:/.../PROJECT_NAME/vivado_proj`) . All the untracked files will be under this directory.
+ 1. When first starting with a project, create it in a folder called `vivado_proj` (e.g. `PROJECT_NAME/vivado_proj`) . All the untracked files will be under this directory.
 
- 2. Place your source files anywhere you want in your project folder (usually in the `C:/.../PROJECT_NAME/src`).
+ 2. Place your source files anywhere you want in your project folder (usually in the `PROJECT_NAME/src`).
 
     Here is an example of a possible project structure:
     ```
@@ -47,10 +56,10 @@ Vivado is a pain in the ass to source control decently, so these scripts provide
             └── ...
     ```
 
- 3. Initiate the git repository with `git init` on the Tcl Console. This will create the repository, automatically change to your project directory (`C:/.../PROJECT_NAME`), generate the `.gitignore` file and stage it.
+ 3. Initiate the git repository with `git init` on the Tcl Console. This will create the repository, automatically change to your project directory (`PROJECT_NAME`), generate the `.gitignore` file and stage it.
 
  4. Stage your source files with `git add`.
 
- 5. When you are done, `git commit` your project. A `PROJECT_NAME.tcl` script will be created in your `C:/.../PROJECT_NAME` folder and added to your commit.
+ 5. When you are done, `git commit` your project. A `PROJECT_NAME.tcl` script will be created in your `PROJECT_NAME` folder and added to your commit.
 
  6. When opening the project after a cloning, do it by using `Tools -> Run Tcl Script...` and selecting the `PROJECT_NAME.tcl` file created earlier. This will regenerate the project so that you can continue working.