remove comment --, add comment header
[libreriscv.git] / index.mdwn
index 08da2e5928f994927c3c9525b3ce31bdb316e2f6..093dfa824b5ec49a3c6008521d15b6482e088a57 100644 (file)
@@ -1,34 +1,81 @@
-# Welcome to libre-riscv.
+# Welcome to Libre-SOC
+(formerly Libre-RISCV)
 
-This is a publicly editable wiki.
+> We're building a chip. A fast chip. A safe chip. A trusted chip.
 
-All wikis are supposed to have a [[SandBox]], so this one does too.
+> A chip with lots of peripherals. And a VPU.  And a 3D GPU...
 
-This wiki is powered by [[ikiwiki]].
+> Oh and here, have the source code...
 
-This is the sitemap: [[sitemap]]
+Sounds cool? Learn more about the [why](why_a_libresoc) behind Libre-SOC
+and [our mission](The_Mission).
 
-----
+# Our Team
 
-# Resources
+We are proud of our talented and diverse [team](about_us).
 
-* Mailing Lists <http://lists.libre-riscv.org> -
-  Archives at <http://lists.libre-riscv.org/pipermail>
-* Git repositories <http://git.libre-riscv.org>
-  may be cloned publicly with
-  git clone https://git.libre-riscv.org/git/repositoryname.git
+# How Can I Help?
 
+If you would like to fund us, see [[funding]]. We currently have some
+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.
 
-# Main Pages
+If you want to write code with us, keep reading.  If you want to *learn* so that you can write code with us, see below.
 
-* Libre-RISCV [[charter]]
-* [[shakti/m_class]]
-* [[alt_rvp]]
-* [[3d_gpu]]
-* [[simple_v_extension]]
-* [[harmonised_rvv_rvp]]
+1. First, join the
+[mailing list](http://lists.libre-riscv.org/mailman/listinfo/libre-riscv-dev),
+introduce yourself, and read through
+[recent posts](http://lists.libre-riscv.org/pipermail/libre-riscv-dev/)
+and the [[charter]].
+2. The next thing you should do is read through the [bugs
+list](http://bugs.libre-riscv.org) and see if there are any bugs that
+pique your interest.
+3. After that, go ahead and take a look at the resources section below. 
+Try and clone a repository with
+``git clone https://git.libre-riscv.org/git/repositoryname.git``
+4. If you plan to do HDL work, you should familiarize yourself with our
+   [[HDL_workflow]].
+5. We do have funding available (see [[nlnet]]) upon completion of issues -
+we are also working on procuring more funding which gets the project to
+nanometre scale tapeout.
+6. After all this, if you feel that Libre-SOC is a something that
+you would like to contribute to, add yourself to the [current_members](about_us)
+page, fill in some information about yourself, and join the mailing list
+and say hello.
 
-# Spike Emulator
-* [Set-Up Instructions][1]
+Also note that you can edit this wiki. See the last section of this page.
 
-[1]: https://libre-riscv.org/3d_gpu/spike_sv/
+## How can I learn?
+
+The whole purpose of this project is to be a learning environment as well as an actual business.  If you want to learn how to do ASIC design, with a view to contributing or starting your own ASIC business, start here: [[3d_gpu/tutorial]]. Yes, really: do not let anyone tell you that you can't learn this stuff too.
+
+Along the way, if you find any resources or links that you found particularly helpful, please add them to that page so that other people can also benefit.
+
+## Needed Skills
+
+Most labor is currently being applied to developing the GPU portion of
+the Libre-SOC.
+
+The highest priority needed at the moment is a c++ engineer 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)
+
+Medium to long-term we need HDL engineers. Particularly those familiar
+with nMigen or just python.  Most of the techniques being used require
+software engineering skills (OO design, polymorphism) than they do more
+traditional HDL programming skills. Basically if you have experience in 2
+of the following you'll do fine: python, nmigen, verilog/VHDL/gate-level
+design. See [[HDL_workflow]]
+
+Also, individuals with experience in formal mathematical verification
+are quite welcome.
+
+List of upcoming project tasks/milestones:
+
+* [Upcoming tasks][1]
+* [NLNet Milestones][2]
+
+[1]: http://bugs.libre-riscv.org/describecomponents.cgi?product=Libre%20Shakti%20M-Class
+[2]: http://bugs.libre-riscv.org/describecomponents.cgi?product=Libre%20Shakti%20M-Class