Bug 660 - "First developer steps" documentation page
Summary: "First developer steps" documentation page
Status: IN_PROGRESS
Alias: None
Product: Libre-SOC's first SoC
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: All All
: --- enhancement
Assignee: dmitry.selyutin
URL: https://libre-soc.org/docs/firststeps/
Depends on:
Blocks: 384
  Show dependency treegraph
 
Reported: 2021-07-24 13:23 BST by dmitry.selyutin
Modified: 2021-09-04 11:47 BST (History)
2 users (show)

See Also:
NLnet milestone: NLNet.2019.10.Wishbone
total budget (EUR) for completion of task and all subtasks: 250
budget (EUR) for this task, excluding subtasks' budget: 250
parent task for budget allocation: 384
child tasks for budget allocation:
The table of payments (in EUR) for this task; TOML format:
dmitry_3mdeb=125 maciej_3mdeb=125


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description dmitry.selyutin 2021-07-24 13:23:43 BST
Currently libre-soc lacks the page which describes very basic development steps, like where to start from, how to run the first test, what this test does, where are the crucial specs that we implement and so on. Based on discussion with Luke and my own observations, I'd like to introduce this page so that it is used by newcomers as an entry point.
Comment 1 dmitry.selyutin 2021-07-26 05:19:10 BST
Status: submitted the first part (basically everything until gory details). For now I have problems with the repository access.

$ git pull origin master --rebase
FATAL: R any libreriscv dmitry3mdeb DENIED by fallthru
(or you mis-spelled the reponame)
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

$ ssh gitolite3@git.libre-soc.org 
PTY allocation request failed on channel 0
hello dmitry3mdeb, this is gitolite3@libre-soc running gitolite3 3.6.11-2 (Debian) on git 2.29.2
Comment 2 dmitry.selyutin 2021-07-26 05:20:32 BST
> $ ssh gitolite3@git.libre-soc.org 
> PTY allocation request failed on channel 0
> hello dmitry3mdeb, this is gitolite3@libre-soc running gitolite3 3.6.11-2
> (Debian) on git 2.29.2
I didn't paste the whole output here, but what's really important is that there's no libreriscv repository.
Comment 3 Luke Kenneth Casson Leighton 2021-07-26 21:48:32 BST
(In reply to dmitry.selyutin from comment #2)

> I didn't paste the whole output here, but what's really important is that
> there's no libreriscv repository.

downgraded gitolite3 to 3.6.something.
Comment 4 dmitry.selyutin 2021-08-09 19:36:40 BST
Status: updated the docs with the intro into the world of markdown and pseudocode. That's quite a quick intro, since the document is already quite big; anyway, if you feel I forgot to tell something at this page, please, let me know.
Comment 5 Luke Kenneth Casson Leighton 2021-08-09 21:30:23 BST
(In reply to dmitry.selyutin from comment #4)
> Status: updated the docs with the intro into the world of markdown and
> pseudocode. 

looks great, dmitry. once you have this
on an about homepage i'll close it as fixed. http://libre-soc.org/dmitry or perhaps http://libre-soc.org/3mdeb/dmitry use my page as a template http://libre-soc.org/lkcl
Comment 6 Luke Kenneth Casson Leighton 2021-08-10 16:24:30 BST
(In reply to Luke Kenneth Casson Leighton from comment #5)

> perhaps http://libre-soc.org/3mdeb/dmitry use my page as a template
> http://libre-soc.org/lkcl

created a stub for you.