Skip to content

Commit a6278ff

Browse files
committed
[add] README, LICENSE, update directory structural
1 parent 8ca292b commit a6278ff

5 files changed

Lines changed: 131 additions & 2 deletions

File tree

.github/workflows/envbase.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111
env:
1212
REGISTRY: ghcr.io
1313
IMAGE_NAME: xs-mlvp/envbase
14-
IMAGE_TAG: ${{ github.sha }}
14+
IMAGE_TAG: ${{ github.sha.substring(0, 7) }}
1515

1616
jobs:
1717
build-and-push:
@@ -38,7 +38,8 @@ jobs:
3838
uses: docker/build-push-action@v4
3939
with:
4040
context: .
41-
file: ./Dockerfile
41+
file: ./docker/Dockerfile
42+
platforms: linux/amd64,linux/arm64
4243
push: true
4344
tags: |
4445
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}

LICENSE

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
Copyright (c) [2025] [XS-MLVP]
2+
unitychip-tutorial is licensed under Mulan PSL v2.
3+
You can use this software according to the terms and conditions of the Mulan PSL v2.
4+
You may obtain a copy of Mulan PSL v2 at:
5+
http://license.coscl.org.cn/MulanPSL2
6+
THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
7+
EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
8+
MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
9+
See the Mulan PSL v2 for more details.
10+
11+
Mulan Permissive Software License,Version 2 (Mulan PSL v2)
12+
13+
January 2020 http://license.coscl.org.cn/MulanPSL2
14+
15+
Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions:
16+
17+
0. Definition
18+
19+
Software means the program and related documents which are licensed under this License and comprise all Contribution(s).
20+
21+
Contribution means the copyrightable work licensed by a particular Contributor under this License.
22+
23+
Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License.
24+
25+
Legal Entity means the entity making a Contribution and all its Affiliates.
26+
27+
Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity.
28+
29+
1. Grant of Copyright License
30+
31+
Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not.
32+
33+
2. Grant of Patent License
34+
35+
Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken.
36+
37+
3. No Trademark License
38+
39+
No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in section 4.
40+
41+
4. Distribution Restriction
42+
43+
You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software.
44+
45+
5. Disclaimer of Warranty and Limitation of Liability
46+
47+
THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
48+
49+
6. Language
50+
51+
THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL.
52+
53+
END OF THE TERMS AND CONDITIONS

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# UnityChip Tutorial Environment Repository 🐳
2+
3+
4+
This repository contains everything needed to set up the Picker tool's complete development environment. It provides pre-built Docker images and materials for our tutorial series.
5+
6+
7+
## 📦 Repository Contents
8+
9+
```sh
10+
.
11+
├── docker/ # Docker configurations
12+
│ ├── Dockerfile # Base image definition
13+
│ ├── Dockerfile.full # Full image definition
14+
│ ├── build-scripts/ # Automated build utilities
15+
│ └── compose/ # (Optional) Docker-compose files
16+
├── tutorials/ # Workshop materials
17+
│ ├── ppt/ # Presentation slides
18+
│ └── code-samples/ # Demo scripts
19+
├── LICENSE
20+
└── README.md # This document
21+
```
22+
23+
## 🚀 Getting Started
24+
25+
### Pre-built Docker Images 💿
26+
27+
1. ​Basic environment
28+
```sh
29+
# This is the base image for the UnityChip tutorial environment, only picker tool is installed without any additional frameworks (e.g. toffee, XSPdb, etc.)
30+
docker pull ghcr.io/xs-mlvp/envbase:latest
31+
```
32+
Ubuntu 22.04, Python 3.10 + essential development tools
33+
> Note: This image is smaller and faster to download, but it does not include any additional frameworks. You can install them manually if needed. If you want try picker for your own, this is the image to start with.
34+
35+
2. ​Full environment
36+
```sh
37+
# This is the full image for the UnityChip tutorial environment, which includes the picker tool and all additional frameworks.
38+
docker pull ghcr.io/xs-mlvp/envfull:latest
39+
```
40+
Ubuntu 22.04, Python 3.10 + essential development tools + additional frameworks (e.g. toffee, XSPdb, etc.)
41+
> Note: The full image is larger and may take longer to download, but it includes everything you need to get started with the UnityChip tutorial environment.
42+
43+
### Build Your Own Image 🔨
44+
45+
If you want to build your own image, you can use the provided Dockerfile. This is useful if you want to customize the environment or add additional tools.
46+
47+
#### Requirements
48+
49+
- Docker Engine ≥20.10
50+
- 8GB+ free disk space
51+
52+
#### Build Commands
53+
54+
```sh
55+
# Build base image
56+
./docker/build-scripts/build-base.sh
57+
58+
# Build full toolkit image
59+
./docker/build-scripts/build-full.sh
60+
```
61+
62+
### Image Contents 🛠️
63+
64+
Images include:
65+
66+
- `Picker` in /usr/local/bin
67+
- `verilator` in /usr/local/bin
68+
- Examples in /workspace/
69+
70+
## 📚 Tutorial Materials
71+
72+
Find workshop resources in repo's /tutorials directory:
73+
74+
- Slide decks (PDF/PPTX)
75+
- Code templates
File renamed without changes.

docker/Dockerfile.full

Whitespace-only changes.

0 commit comments

Comments
 (0)