Merge pull request #88 from tudortimi/fix-readme

Fix README

README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cccc1b5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# SVUnit
+
+SVUnit is an open-source test framework for ASIC and FPGA developers writing Verilog/SystemVerilog
+code. SVUnit is automated, fast, lightweight and easy to use making it the only SystemVerilog test
+framework in existence suited to both design and verification engineers that aspire to high quality
+code and low bug rates.
+
+NOTE: for instructions on how to get going with SVUnit, go to
+      www.agilesoc.com/svunit.
+
+NOTE: Refer also to the FAQ at: www.agilesoc.com/svunit/svunit-FAQ
+
+
+## Release Notes
+
+Go [here](CHANGELOG.md) for release notes.
+
+
+## Step-by-step instructions to get a first unit test going
+
+### 1. Set up the `SVUNIT_INSTALL` and `PATH` environment variables
+
+```shell
+export SVUNIT_INSTALL=`pwd`
+export PATH=$PATH:$SVUNIT_INSTALL"/bin"
+```
+
+You can source `Setup.bsh` if you use the bash shell.
+
+```shell
+source Setup.bsh
+```
+
+You can source `Setup.csh` if you use the csh shell.
+
+```shell
+source Setup.csh
+```
+
+### 2. Go somewhere outside `SVUNIT_INSTALL` (i.e. where you are right now)
+
+Start a class-under-test:
+
+
+    // file: bogus.sv
+    class bogus;
+    endclass
+
+### 3. Generate the unit test
+
+```shell
+create_unit_test.pl bogus.sv
+```
+
+### 4. Add tests using the helper macros
+
+    // file: bogus_unit_test.sv
+    `SVUNIT_TESTS_BEGIN
+
+      //===================================
+      // Unit test: test_mytest
+      //===================================
+      `SVTEST(test_mytest)
+      `SVTEST_END
+
+    `SVUNIT_TESTS_END
+
+### 5. Run the unit tests
+
+```shell
+runSVUnit -s <simulator> # simulator is ius, questa, modelsim, riviera or vcs
+```
+
+### 6. Repeat steps 4 and 5 until done
+
+### 7. Pat self on back

README.txt

diff --git a/README.txt b/README.txt
deleted file mode 100644
index e8311a1..0000000
--- a/README.txt
+++ /dev/null
@@ -1,76 +0,0 @@
-############################################################################
-#
-#  Copyright 2011 The SVUnit Authors.
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-#
-############################################################################
-
-NOTE: for instructions on how to get going with SVUnit, go to
-      www.agilesoc.com/svunit.
-
-NOTE: Refer also to the FAQ at: www.agilesoc.com/svunit/svunit-FAQ
-
-
-
------------------------------------------------------------
-Release Notes...
------------------------------------------------------------
-See RELEASE.txt for release notes
-
-
-
------------------------------------------------------------
-Step-by-step instructions to get a first unit test going...
------------------------------------------------------------
-
-1) setup the SVUNIT_INSTALL and PATH environment variables
->export SVUNIT_INSTALL=`pwd`
->export PATH=$PATH:$SVUNIT_INSTALL"/bin"
-
-1a) or you can source the Setup.bsh (if you use the bash shell)
->source Setup.bsh
-
-1b) or you can source the Setup.csh (if you use the csh shell)
->source Setup.csh
-
-2) go somewhere outside SVUNIT_INSTALL (i.e. where you are right now)
-and start a class-under-test
----
-  bogus.sv:
-    class bogus;
-    endclass
----
-
-3) generate the unit test
->create_unit_test.pl bogus.sv
-
-4) add tests using the helper macros
----
-  bogus_unit_test.sv:
-    `SVUNIT_TESTS_BEGIN
-    //===================================
-    // Unit test: test_mytest
-    //===================================
-    `SVTEST(test_mytest)
-    `SVTEST_END
-
-    `SVUNIT_TESTS_END
----
-
-5) run the unittests
->runSVUnit -s <simulator> # simulator is ius, questa, modelsim, riviera or vcs
-
-6) repeat steps 4 and 5 until done
-
-7) pat self on back