summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMegan Wachs <megan@sifive.com>2016-07-20 23:59:02 +0000
committerMegan Wachs <megan@sifive.com>2016-07-26 08:40:12 -0700
commit2887165ae2990e7f93038f3220ed74ee429b5244 (patch)
tree13c4cb83e47d6ab390e0465e883acf0973611e8e /README.md
parenta2d28c8318ab3ed40b3674aeee8b9487a3129f15 (diff)
Initial Checkin
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7aae18
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# README #
+
+This repository, maintained by SiFive, Inc, makes it easy to get started developing software for the Freedom E RISC-V platform.
+
+### Contents ###
+
+* RISC-V Software Toolchain
+* RISC-V Debugging Toolchain
+* FPGA Toolchain Commands (Specific to the Freedom E300 Arty Development Kit).
+
+### Setting up the SDK ###
+
+First, clone this repository:
+
+```
+git clone --recursive http://github.com/sifive/freedom-e-sdk.git
+```
+
+Next, build the tools:
+
+```
+cd freedom-e-sdk
+make tools
+```
+
+To compile a bare-metal RISC-V program:
+
+```
+cd freedom-e-sdk
+make software [PROGRAM=demo_gpio]
+```
+
+To see additional options:
+
+```
+cd freedom-e-sdk
+make help
+```
+
+### For More Information ###
+
+Documentation, Forums, and much more available at
+
+[dev.sifive.com](http://dev.sifive.com) \ No newline at end of file