(no commit message)

[libreriscv.git] / index.mdwn

diff --git a/index.mdwn b/index.mdwn
index 2789f3755abe7d099701472294e28c6c38edd84b..317b1aae66e53adff34db7d2d08b676be163b177 100644 (file)
--- a/index.mdwn
+++ b/index.mdwn
@@ -64,6 +64,9 @@ We are proud of our talented and diverse [team](about_us).
   See the upcoming [Hackathon](https://www.youtube.com/embed/Px6eakWja3Q"),
   deadline May 15th
 * The [[PowerPC Notebook]] Project
+* [RED Semiconductor](http://redsemiconductor.com) is the commercial realisation of Libre-SOC technology that respects and actively supports Libre principles in its business objectives.
+* [[fed4fire]] for supercomputer access for verilator simulations,
+  with thanks to Ghent University / IMEC.
 
 # How Can I Help?
 
@@ -72,7 +75,7 @@ funding and always appreciate more!  If you are a Corporation or an
 individual you can donate tax-free to NLNet, and they can in turn gift
 our developers.  Contact lkcl@lkcl.net for more information.
 
-# How Can I Help as a Developer?
+# How Can I Help as a Developer? <a name="help_as_developer"></a>
 
 If you want to write code with us (and receive donations from NLNet
 for doing so), keep reading.  If you want to *learn*
@@ -82,10 +85,13 @@ just get in touch on the list, there is plenty to do.
 
 1. First, join the
   [mailing list](http://lists.libre-soc.org/mailman/listinfo/libre-soc-dev),
-  introduce yourself (people will happily say "hello" back"). Read through
+  introduce yourself (people will happily say "hello" back") and
+  the Freenode IRC channel
+  [#libre-soc](https://libre-soc.org/irclog/latest.log.html).
+  Read through
   [recent posts](http://lists.libre-soc.org/pipermail/libre-soc-dev/)
-  and the [[charter]], and let everyone know, on the list that you're
-  happy with it and agree to it.
+  and the [[charter]], ask questions if you have any and let everyone know,
+  on the list that you're happy with it and agree to it.
 2. The next thing you should do is read through the
   [bugs list](http://bugs.libre-soc.org) and
   see if there are any bugs that pique your interest.
@@ -108,7 +114,8 @@ Also note that you can edit this wiki.  You can experiment in the [[Sandbox]].
 
 ## Quick peek at the code
 
-Here is an example process of how to play with the soc code:
+Here is an example process of how to play with the soc code.  The last
+step you will have needed to install yosys:
 
     pip3 install virtualenv requests
     mkdir ~/.virtualenvs && cd ~/.virtualenvs
@@ -116,17 +123,31 @@ Here is an example process of how to play with the soc code:
     source ~/.virtualenvs/libresoc/bin/activate
     
     cd ~; mkdir libresoc; cd libresoc
+    git clone https://git.libre-soc.org/git/nmigen.git
+    git clone https://git.libre-soc.org/git/nmigen-soc.git
     git clone https://git.libre-soc.org/git/nmutil.git
+    git clone https://git.libre-soc.org/git/openpower-isa.git
+    git clone https://git.libre-soc.org/git/c4m-jtag.git
     git clone https://git.libre-soc.org/git/ieee754fpu.git
     git clone https://git.libre-soc.org/git/soc.git
     
-    cd nmutil; make install; cd ..
-    cd ieee754fpu; make install; cd ..
-    cd soc; make gitupdate; make install; cd ..
+    cd nmigen; python setup.py develop; cd ..
+    cd nmigen-soc; python setup.py develop; cd ..
+    cd c4m-jtag; python setup.py develop; cd ..
+    cd nmutil; make develop; cd ..
+    cd openpower-isa; make develop; cd ..
+    cd ieee754fpu; make develop; cd ..
+    cd soc; make gitupdate; make develop
     
-    python3 soc/src/soc/decoder/power_decoder.py
+    python3 src/soc/decoder/power_decoder.py
     yosys -p "read_ilang decoder.il; show dec31" 
 
+The full install process may be automated using scripts found
+here: <https://git.libre-soc.org/?p=dev-env-setup.git;a=summary>
+which you can clone with:
+
+    git clone https://git.libre-soc.org/git/dev-env-setup.git
+
 ## How can I learn?
 
 The whole purpose of this project is to be a learning environment as well
@@ -154,13 +175,13 @@ design. See [[HDL_workflow]]
 
 We also need to find a c++ engineer with compiler experience to work on
 a MESA 3D driver. This will begin life similar to SwiftShader however
-retaining the vectorisation and predication intrinsics as well as hardware
-accelerated opcodes (all of which SwiftShader lacks)
+retaining the vectorisation and predication intrinsics then adding
+hardware accelerated opcodes (all of which SwiftShader lacks)
 
 Also, individuals with experience in formal mathematical verification
 are quite welcome.
 
 # Documentation
 
- - [Source Code](/Documentation/index)
+ - [Source Code](/docs/)
  - [Architecture](3d_gpu/architecture)