Permalink
Browse files

Add README.pod

  • Loading branch information...
juliusbaxter committed Aug 21, 2012
1 parent 53446c7 commit 90c12e6140efdc843f41c833644e01e88a6591df
Showing with 29 additions and 0 deletions.
  1. +29 −0 README.pod
View
@@ -0,0 +1,29 @@
+
+=pod
+
+=head1 I<< mor1kx >> - an OpenRISC processor IP core
+
+=head2 The Basics
+
+This repository contains an OpenRISC 1000 compliant processor IP core.
+
+It is written in Verilog HDL.
+
+This repository only contains the IP source code and some documentation. For
+a verification environment, please see other projects.
+
+=head2 Documentation
+
+The documentation is located in the doc/ directory.
+
+It is asciidoc format, and there's a makefile in there to build HTML or PDF. To
+build the HTML documentation, run the following in the doc/ directory:
+
+ make html
+
+=head2 License
+
+It is licensed under the Open Hardware Description License (OHDL). For
+details please see the LICENSE file or http://juliusbaxter.net/ohdl/
+
+=cut

0 comments on commit 90c12e6

Please sign in to comment.