try different format
[libreriscv.git] / index.mdwn
1 # Welcome to Libre-SOC
2 (formerly Libre-RISCV)
3
4 We're building a chip. A fast chip. A safe chip. A trusted chip.
5 A chip with lots of peripherals. And a VPU. And a 3D GPU...
6 Oh and here, have the [source code](http://git.libre-riscv.org)...
7
8 Sounds cool? Learn more about the [why](why_a_libresoc) behind Libre-SOC
9 and [our mission](The_Mission).
10
11 # Our Team
12
13 We are proud of our talented and diverse [team](about_us).
14
15 # How Can I Help?
16
17 If you would like to fund us, see [[funding]]. We currently have some
18 funding and always appreciate more! If you are a Corporation or an
19 individual you can donate tax-free to NLNet, and they can in turn gift
20 our developers. Contact lkcl@lkcl.net for more information.
21
22 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. If there is anything else, just get in touch on the list, there is plenty to do.
23
24 1. First, join the
25 [mailing list](http://lists.libre-riscv.org/mailman/listinfo/libre-riscv-dev),
26 introduce yourself (people will happily say "hello" back"). Read through
27 [recent posts](http://lists.libre-riscv.org/pipermail/libre-riscv-dev/)
28 and the [[charter]], and let everyone know, on the list that you're
29 happy with it and agree to it.
30 2. The next thing you should do is read through the [bugs
31 list](http://bugs.libre-riscv.org) and see if there are any bugs that
32 pique your interest.
33 3. After that, go ahead and take a look at the resources section below.
34 Try and clone a repository with
35 ``git clone https://git.libre-riscv.org/git/repositoryname.git``
36 4. If you plan to do HDL work, you should familiarize yourself with our
37 [[HDL_workflow]].
38 5. We do have funding available (see [[nlnet]]) upon completion of issues -
39 we are also working on procuring more funding which gets the project to
40 nanometre scale tapeout.
41 6. After all this, if you feel that Libre-SOC is a something that
42 you would like to contribute to, add yourself to the [current_members](about_us)
43 page, fill in some information about yourself, and join the mailing list
44 and say hello.
45
46 Also note that you can edit this wiki. You can experiment in the [[Sandbox]].
47
48 ## How can I learn?
49
50 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.
51
52 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 (and you have a place to remember them, too).
53
54 ## Needed Skills
55
56 Most labor is currently being applied to developing the GPU portion of
57 the Libre-SOC.
58
59 The highest priority needed at the moment is a c++ engineer to work on
60 a MESA 3D driver. This will begin life similar to SwiftShader however
61 retaining the vectorisation and predication intrinsics as well as hardware
62 accelerated opcodes (all of which SwiftShader lacks)
63
64 Medium to long-term we need HDL engineers. Particularly those familiar
65 with nMigen or just python. Most of the techniques being used require
66 software engineering skills (OO design, polymorphism) than they do more
67 traditional HDL programming skills. Basically if you have experience in 2
68 of the following you'll do fine: python, nmigen, verilog/VHDL/gate-level
69 design. See [[HDL_workflow]]
70
71 Also, individuals with experience in formal mathematical verification
72 are quite welcome.
73