(no commit message)

[libreriscv.git] / HDL_workflow.mdwn

diff --git a/HDL_workflow.mdwn b/HDL_workflow.mdwn
index 559e80453610d8950c7510f8680cad67b063e9fe..c74ddcd1b9d5532ea0c31cb0ce4fd98dd8253dfa 100644 (file)
--- a/HDL_workflow.mdwn
+++ b/HDL_workflow.mdwn
@@ -19,6 +19,17 @@ paramount.
 
 # Collaboration resources
 
+The main message here: **use the right tool for the right job**.
+
+* mailing list: general communication and discussion.
+* bugtracker: task-orientated, goal-orientated *focussed* discussion.
+* ikiwiki: document store, information store, and (editable) main website
+* git repositories: code stores (**not binary or auto-generated output store**)
+* ftp server (<http://ftp.libre-riscv.org>): large file store.
+
+we will add an IRC channel at some point when there are enough people
+to warrant having one.
+
 ## Main contact method: mailing list
 
 To respect the transparency requirements, conversations need to be
@@ -59,7 +70,9 @@ lose track of them. Create a bugreport, find the discussion in the
 archives <http://lists.libre-riscv.org/pipermail/libre-riscv-dev/>,
 and put the link actually in the bugtracker as one of the comments.
 
-At some point it may become better to use  <http://bugs.libre-riscv.org>
+At some point in any discussion, the sudden realisation may dawn on one
+or more people that this is an "actionable" discussion.  at that point
+it may become better to use  <http://bugs.libre-riscv.org>
 itself to continue the discussion rather than to keep on dropping copies
 of links into the bugtracker.  The bugtracker sends copies of comments
 *to* the list however this is 'one-way' (note from lkcl: because this
@@ -116,6 +129,16 @@ utilisation.  reminder: lions are involved if github is mentioned.
 
 gitweb is provided which does a decent job. <http://git.libre-riscv.org>
 
+## ftp server
+
+<http://ftp.libre-riscv.org> is available for storing large files
+that do not belong in a git repository, if we have (or ever need)
+any.  images (etc.) if small and appropriate should go into the
+wiki, however .tgz archives (etc.) and, at some point, binaries,
+should be on the ftp server.
+
+ask on the list if you have a file that belongs on the ftp server.
+
 ## server
 
 as an aside: all this is "old school" and run on a single core 512MB
@@ -123,7 +146,8 @@ VM with only a 20GB HDD allocation. it costs only 8 GBP per month from
 mythic-beasts and means that the project is in no way dependent on anyone
 else - not microsoft, not google, not facebook, not amazon.
 
-we tried gitlab. it didn't go well.
+we tried gitlab. it didn't go well. please don't ask to replace the
+above extremely resource-efficient resources with it.
 
 # Hardware
 
@@ -364,11 +388,12 @@ if you want it, always ensure that a new git checkout is set up with rebase.
 
 * mkdir ~/src
 * cd !$
-* git clone gitolite3@git.libre-riscv.org:soc.git
+* git clone gitolite3@git.libre-riscv.org:nmutil.git
 * git clone gitolite3@git.libre-riscv.org:ieee754fpu.git
+* git clone gitolite3@git.libre-riscv.org:soc.git
 
-In each of these directories, track down the setup.py file, then, as root
-(sudo bash) run the following:
+In each of these directories, in the order listed, track down the
+setup.py file, then, as root (sudo bash), run the following:
 
 * python3 setup.py develop
 
@@ -377,6 +402,9 @@ in-place yet still imported "globally".  There are variants on this theme
 for multi-user machine use however it is often just easier to get your
 own machine these days.
 
+The reason for the order is because soc depends on ieee754fpu, and
+ieee754fpu depends on nmutil
+
 If "python3 setup.py install" is used it is a pain: edit, then
 install. edit, then install. It gets extremely tedious, hence why
 "develop" was created.