Skip to content

Commit 7d6b676

Browse files
ilg-ulilg-ul
committed
move to build-assets
1 parent 4228fb2 commit 7d6b676

18 files changed

+546
-464
lines changed

‎README-LONG.md‎

Lines changed: 248 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,248 @@
1+
2+
[![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack-dev-tools/qemu-riscv-xpack)](https://github.com/xpack-dev-tools/qemu-riscv-xpack/blob/xpack/package.json)
3+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/xpack-dev-tools/qemu-riscv-xpack)](https://github.com/xpack-dev-tools/qemu-riscv-xpack/releases/)
4+
[![npm (scoped)](https://img.shields.io/npm/v/@xpack-dev-tools/qemu-riscv.svg?color=blue)](https://www.npmjs.com/package/@xpack-dev-tools/qemu-riscv/)
5+
[![license](https://img.shields.io/github/license/xpack-dev-tools/qemu-riscv-xpack)](https://github.com/xpack-dev-tools/qemu-riscv-xpack/blob/xpack/LICENSE)
6+
7+
# The xPack QEMU RISC-V
8+
9+
A standalone cross-platform (Windows/macOS/Linux) **QEMU RISC-V**
10+
binary distribution, intended for reproducible builds.
11+
12+
In addition to the the binary archives and the package meta data,
13+
this project also includes the build scripts.
14+
15+
## Overview
16+
17+
This open source project is hosted on GitHub as
18+
[`xpack-dev-tools/qemu-riscv-xpack`](https://github.com/xpack-dev-tools/qemu-riscv-xpack)
19+
and provides the platform specific binaries for the
20+
[xPack QEMU RISC-V](https://xpack.github.io/qemu-riscv/).
21+
22+
This distribution is based on an older release of the official
23+
[QEMU](https://www.qemu.org).
24+
25+
The binaries can be installed automatically as **binary xPacks** or manually as
26+
**portable archives**.
27+
28+
## Release schedule
29+
30+
This distribution plans to follow the official QEMU major releases,
31+
possibly with intermediate releases if necessary.
32+
33+
## User info
34+
35+
This section is intended as a shortcut for those who plan
36+
to use the QEMU RISC-V binaries. For full details please read the
37+
[xPack QEMU RISC-V](https://xpack.github.io/qemu-riscv/) pages.
38+
39+
### Easy install
40+
41+
The easiest way to install QEMU RISC-V is using the **binary xPack**, available as
42+
[`@xpack-dev-tools/qemu-riscv`](https://www.npmjs.com/package/@xpack-dev-tools/qemu-riscv)
43+
from the [`npmjs.com`](https://www.npmjs.com) registry.
44+
45+
#### Prerequisites
46+
47+
A recent [xpm](https://xpack.github.io/xpm/),
48+
which is a portable [Node.js](https://nodejs.org/) command line application
49+
that complements [npm](https://docs.npmjs.com)
50+
with several extra features specific to
51+
**C/C++ projects**.
52+
53+
It is recommended to install/update to the latest version with:
54+
55+
```sh
56+
npm install --location=global xpm@latest
57+
```
58+
59+
For details please follow the instructions in the
60+
[xPack install](https://xpack.github.io/install/) page.
61+
62+
#### Install
63+
64+
With the `xpm` tool available, installing
65+
the latest version of the package and adding it as
66+
a development dependency for a project is quite easy:
67+
68+
```sh
69+
cd my-project
70+
xpm init # Add a package.json if not already present
71+
72+
xpm install @xpack-dev-tools/qemu-riscv@latest --verbose
73+
74+
ls -l xpacks/.bin
75+
```
76+
77+
This command will:
78+
79+
- install the latest available version,
80+
into the central xPacks store, if not already there
81+
- add symbolic links to the central store
82+
(or `.cmd` forwarders on Windows) into
83+
the local `xpacks/.bin` folder.
84+
85+
The central xPacks store is a platform dependent
86+
location in the home folder;
87+
check the output of the `xpm` command for the actual
88+
folder used on your platform.
89+
This location is configurable via the environment variable
90+
`XPACKS_STORE_FOLDER`; for more details please check the
91+
[xpm folders](https://xpack.github.io/xpm/folders/) page.
92+
93+
For xPacks aware tools, like the **Eclipse Embedded C/C++ plug-ins**,
94+
it is also possible to install QEMU globally, in the user home folder:
95+
96+
```sh
97+
xpm install --global @xpack-dev-tools/qemu-riscv@latest --verbose
98+
```
99+
100+
Eclipse will automatically
101+
identify binaries installed with
102+
`xpm` and provide a convenient method to manage paths.
103+
104+
After install, the package should create a structure like this (macOS files;
105+
only the first two depth levels are shown):
106+
107+
```console
108+
$ tree -L 2 /Users/ilg/Library/xPacks/@xpack-dev-tools/qemu-riscv/8.2.2-1.1/.content/
109+
/Users/ilg/Library/xPacks/@xpack-dev-tools/qemu-riscv/8.2.2-1.1/.content/
110+
├── README.md
111+
├── bin
112+
│   ├── qemu-system-riscv32
113+
│   └── qemu-system-riscv64
114+
├── distro-info
115+
│   └── licenses
116+
├── include
117+
│   ├── fdt.h
118+
│   ├── libfdt.h
119+
│   ├── libfdt_env.h
120+
│   └── qemu-plugin.h
121+
├── lib
122+
│   ├── libfdt.a
123+
│   └── pkgconfig
124+
├── libexec
125+
│   ├── libbz2.1.0.8.dylib
126+
│   ├── libcrypto.1.1.dylib
127+
│   ├── libffi.8.dylib
128+
│   ├── libgio-2.0.0.dylib
129+
│   ├── libglib-2.0.0.dylib
130+
│   ├── libgmodule-2.0.0.dylib
131+
│   ├── libgmp.10.dylib
132+
│   ├── libgobject-2.0.0.dylib
133+
│   ├── libhogweed.6.8.dylib
134+
│   ├── libhogweed.6.dylib -> libhogweed.6.8.dylib
135+
│   ├── libiconv.2.dylib
136+
│   ├── libintl.8.dylib
137+
│   ├── libjpeg.9.dylib
138+
│   ├── liblzo2.2.dylib
139+
│   ├── libncursesw.6.dylib
140+
│   ├── libnettle.8.8.dylib
141+
│   ├── libnettle.8.dylib -> libnettle.8.8.dylib
142+
│   ├── libpcre2-8.0.dylib
143+
│   ├── libpixman-1.0.dylib
144+
│   ├── libpng16.16.dylib
145+
│   ├── libssh.4.9.6.dylib
146+
│   ├── libssh.4.dylib -> libssh.4.9.6.dylib
147+
│   ├── libusb-1.0.0.dylib
148+
│   ├── libvdeplug.3.dylib
149+
│   ├── libz.1.3.1.dylib
150+
│   ├── libz.1.dylib -> libz.1.3.1.dylib
151+
│   ├── libzstd.1.5.5.dylib
152+
│   └── libzstd.1.dylib -> libzstd.1.5.5.dylib
153+
└── share
154+
├── applications
155+
├── icons
156+
└── qemu
157+
158+
12 directories, 36 files
159+
```
160+
161+
No other files are installed in any system folders or other locations.
162+
163+
#### Uninstall
164+
165+
The binaries are distributed as portable archives; thus they do not need
166+
to run a setup and do not require an uninstall; simply removing the
167+
folder is enough.
168+
169+
To remove the links created by xpm in the current project:
170+
171+
```sh
172+
cd my-project
173+
174+
xpm uninstall @xpack-dev-tools/qemu-riscv
175+
```
176+
177+
To completely remove the package from the central xPack store:
178+
179+
```sh
180+
xpm uninstall --global @xpack-dev-tools/qemu-riscv
181+
```
182+
183+
### Manual install
184+
185+
For all platforms, the **xPack QEMU RISC-V**
186+
binaries are released as portable
187+
archives that can be installed in any location.
188+
189+
The archives can be downloaded from the
190+
GitHub [Releases](https://github.com/xpack-dev-tools/qemu-riscv-xpack/releases/)
191+
page.
192+
193+
For more details please read the
194+
[Install](https://xpack.github.io/qemu-riscv/install/) page.
195+
196+
### Versioning
197+
198+
The version strings used by the QEMU project are three number strings
199+
like `8.2.2`; to this string the xPack distribution adds a four number,
200+
but since semver allows only three numbers, all additional ones can
201+
be added only as pre-release strings, separated by a dash,
202+
like `8.2.2-1`. When published as a npm package, the version gets
203+
a fifth number, like `8.2.2-1.1`.
204+
205+
Since adherence of third party packages to semver is not guaranteed,
206+
it is recommended to use semver expressions like `^8.2.2` and `~8.2.2`
207+
with caution, and prefer exact matches, like `8.2.2-1.1`.
208+
209+
## Maintainer info
210+
211+
For maintainer info, please see the
212+
[README-MAINTAINER](https://github.com/xpack-dev-tools/qemu-riscv-xpack/blob/xpack/README-MAINTAINER.md).
213+
214+
## Support
215+
216+
The quick advice for getting support is to use the GitHub
217+
[Discussions](https://github.com/xpack-dev-tools/qemu-riscv-xpack/discussions/).
218+
219+
For more details please read the
220+
[Support](https://xpack.github.io/qemu-riscv/support/) page.
221+
222+
## License
223+
224+
Unless otherwise stated, the content is released under the terms of the
225+
[MIT License](https://opensource.org/licenses/mit/),
226+
with all rights reserved to
227+
[Liviu Ionescu](https://github.com/ilg-ul).
228+
229+
The binary distributions include several open-source components; the
230+
corresponding licenses are available in the installed
231+
`distro-info/licenses` folder.
232+
233+
## Download analytics
234+
235+
- GitHub [`xpack-dev-tools/qemu-riscv-xpack`](https://github.com/xpack-dev-tools/qemu-riscv-xpack/) repo
236+
- latest xPack release
237+
[![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/qemu-riscv-xpack/latest/total.svg)](https://github.com/xpack-dev-tools/qemu-riscv-xpack/releases/)
238+
- all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/qemu-riscv-xpack/total.svg)](https://github.com/xpack-dev-tools/qemu-riscv-xpack/releases/)
239+
- [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=qemu-riscv-xpack) (grouped per release)
240+
- npmjs.com [`@xpack-dev-tools/qemu-riscv`](https://www.npmjs.com/package/@xpack-dev-tools/qemu-riscv/) xPack
241+
- latest release, per month
242+
[![npm (scoped)](https://img.shields.io/npm/v/@xpack-dev-tools/qemu-riscv.svg)](https://www.npmjs.com/package/@xpack-dev-tools/qemu-riscv/)
243+
[![npm](https://img.shields.io/npm/dm/@xpack-dev-tools/qemu-riscv.svg)](https://www.npmjs.com/package/@xpack-dev-tools/qemu-riscv/)
244+
- all releases [![npm](https://img.shields.io/npm/dt/@xpack-dev-tools/qemu-riscv.svg)](https://www.npmjs.com/package/@xpack-dev-tools/qemu-riscv/)
245+
246+
Credit to [Shields IO](https://shields.io) for the badges and to
247+
[Somsubhra/github-release-stats](https://github.com/Somsubhra/github-release-stats)
248+
for the individual file counters.

0 commit comments

Comments
 (0)