Skip to content

Doc naming #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 13, 2020
Merged

Doc naming #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2a4a9f
README: add history to explain naming issues
sashimi-yzh Jul 9, 2020
7ae41b6
README.md: update URL for AM
sashimi-yzh Jul 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 44 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# NutShell
# NutShell (果壳)

NutShell is a processor developed by the OSCPU (Open Source Chip Project by University) team.

NutShell is a processor belonging to OSCPU (Open Source Chip Project by University). <br>
Currently it supports riscv64/32.

See [the History and Naming section](#history) for naming issue.

## Compile chisel code

* Install `mill`. Refer to [the Manual section in this guide][mill].
Expand All @@ -14,7 +17,7 @@ Currently it supports riscv64/32.

* Set a new environment variable `NEMU_HOME` to the **absolute path** of the NEMU project.
* Set a new environment variable `NUTSHELL_HOME` to the **absolute path** of the NutShell project.
* Clone the [AM project](https://github.com/NJU-ProjectN/nexus-am.git).
* Clone the [AM project](https://github.com/OSCPU/nexus-am.git).
* Set a new environment variable `AM_HOME` to the **absolute path** of the AM project.
* Add a new AM `riscv64-nutshell` in the AM project if it is not provided.
* Run the application in the AM project by `make ARCH=riscv64-nutshell run`.
Expand Down Expand Up @@ -84,3 +87,41 @@ minicom -D /dev/ttyUL1
./ddr-loader axu3cg bin-file
```
* To shutdown the board, first run `poweroff` in PS.

## <a name="history"></a> History and Naming

**Is NutShell developed from scratch?**

No.
NutShell is originally based on the NOOP project, an educational RV32 SoC designed by Nanjing University (NJU).
At 2019/08/27, the OSCPU team decided to start a new project based on a fork of NOOP.

**Why was there only one contributor in this repo before 2019/08/27?**

NOOP was maintained by [sashimi-yzh](https://github.com/sashimi-yzh) on behalf of NJU before 2019/08/27.

**What is the different between NutShell and NOOP?**

Undergraduate students in the OSCPU team planned to enhance the educational SoC to a fully functional RV64 SoC,
on behalf of University of Chinese Academy of Sciences (UCAS, 中国科学院大学).
The goal was to boot Linux + Debian and tapeout the chip.
Students have put a lot of effort into achieving such a goal.

**Why can I still find the name NOOP in the code as well as the commit logs after 2019/08/27?**

During the development, the OSCPU team has not yet thought of a good name for the SoC.
Before this repo is available to the public, they finally decide to name the SoC NutShell.
In Chinese, NutShell (果壳) and the nickname of UCAS (国科大) are similar in pronunciation.
The name NutShell is welcomed by every student in UCAS.

**I found a name Argo in the code as well as the commit logs. What is it?**

Argo is the name of a dual-issued OoO core designed by [AugustusWillisWang](https://github.com/AugustusWillisWang).
AugustusWillisWang is one of the students who develop NutShell.
Argo is designed based on NutShell, and they share the same SoC architecture.

**I found a name COOSCA in the commit logs. What is it?**

COOSCA is an internal name of the SoC.
Students in the team want a better name, so there comes NutShell.
The name COOSCA should be rarely presented in the repo.