Skip to content

Commit

Permalink
doc: update git clone branch info to dev_nuclei_6.1
Browse files Browse the repository at this point in the history
Signed-off-by: Huaqi Fang <[email protected]>
  • Loading branch information
fanghuaqi committed Nov 22, 2023
1 parent 19a55c2 commit 61da02e
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Nuclei Linux SDK

[![Build and Test Linux SDK](https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/workflows/build.yml/badge.svg?branch=dev_nuclei_5.10)](https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/workflows/build.yml)
[![Build and Test Linux SDK](https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/workflows/build.yml/badge.svg?branch=dev_nuclei_6.1)](https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/workflows/build.yml)

[![Build Linux SDK Docker Image](https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/workflows/docker.yml/badge.svg?branch=dev_nuclei_5.10)](https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/workflows/docker.yml)
[![Build Linux SDK Docker Image](https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/workflows/docker.yml/badge.svg?branch=dev_nuclei_6.1)](https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/workflows/docker.yml)

Please check [about each branch feature](https://github.com/Nuclei-Software/nuclei-linux-sdk/issues/2) to learn which branch you should choose.

Expand Down Expand Up @@ -70,8 +70,10 @@ existing issues not address your problem, please [create a new issue](https://gi
* Checkout this repository using `git`.

> Change the below `dev_nuclei_6.1` to your desired branch.
- If you have good network access to github, you can clone this repo using command
`git clone https://github.com/Nuclei-Software/nuclei-linux-sdk`
`git clone -b dev_nuclei_6.1 https://github.com/Nuclei-Software/nuclei-linux-sdk`
- Otherwise, you can try methods provided https://github.com/Nuclei-Software/nuclei-linux-sdk/issues/10
- If https is not stable, you can try ssh, please search about git clone ssh/https difference

Expand All @@ -93,8 +95,8 @@ existing issues not address your problem, please [create a new issue](https://gi
and get expected output as below:

~~~
On branch dev_nuclei_next
Your branch is up to date with 'origin/dev_nuclei_next'.
On branch dev_nuclei_6.1
Your branch is up to date with 'origin/dev_nuclei_6.1'.

nothing to commit, working tree clean
~~~
Expand All @@ -113,13 +115,13 @@ source repository).
Update source code if there are new commits in this repo.
Assume currently you are in `dev_nuclei_next` branch, and the working tree is clean.
Assume currently you are in `dev_nuclei_6.1` branch, and the working tree is clean.
Then you run the following command to update this repo:
~~~shell
# Pull lastest source code and rebase your local commits onto it
git pull --rebase origin dev_nuclei_next
git pull --rebase origin dev_nuclei_6.1
# Update git submodules
git submodule update
# Check workspace status to see whether it is clean
Expand Down Expand Up @@ -155,7 +157,6 @@ We support four configurations for **CORE**, choose the right core according to
* `ux600` or `ux900`: rv64imac RISC-V CORE configuration without FPU.
* `ux600fd` or `ux900fd`: rv64imafdc RISC-V CORE configuration with FPU.
* `u900` or `u900fd`: rv32imac/rv32imafdc RISC-V CORE configuration.
You can choose different SoC by modify `SOC ?= demosoc` line in `Makefile`.
Expand Down Expand Up @@ -198,7 +199,7 @@ Contact with our sales via email **[email protected]** to get `xl_spike` too
> This feature is **deprecated** now, please use Nuclei Qemu.
### Run on xl_spike
### Run on xl_spike
If you have run `make bootimages` command before, please make sure you run `make presim` to prepare
build environment for running linux in simulation.
Expand Down Expand Up @@ -365,6 +366,8 @@ If you want to remove the login, and directly enter to bash, please check [**Kno
When the required changes has been done, then you can run `make run_qemu` to run riscv linux on Nuclei QEMU, here are the sample output.
> You can check latest output in github action https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/workflows/build.yml?query=branch%3Adev_nuclei_6.1
~~~
Run on qemu for simulation
qemu-system-riscv64 -M nuclei_evalsoc,download=flashxip -smp 8 -m 2G -cpu nuclei-ux900fd,ext= -bios /Local/hqfang/workspace/software/nuclei-linux-sdk/work/evalsoc/freeloader/freeloader.elf -nographic -drive file=/Local/hqfang/workspace/software/nuclei-linux-sdk/work/evalsoc/disk.img,if=sd,format=raw
Expand Down

0 comments on commit 61da02e

Please sign in to comment.