mirror of
https://github.com/revng/revng
synced 2026-06-21 14:07:57 +00:00
Alessandro Di Federico
123 lines
3.3 KiB
Markdown
123 lines
3.3 KiB
Markdown
We'll now introduce how to set up a working rev.ng environment, both as a user, just downloading a binary distribution, or as a developer, installing `orchestra`, our package manager.
|
|
|
|
Note that, as of now, rev.ng can only run on Linux x86-64.
|
|
However, you can run it on Windows using [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and on macOS [via Docker](#docker).
|
|
|
|
## Installing rev.ng as a user
|
|
|
|
It should be as simple as:
|
|
|
|
```{bash notest}
|
|
$ curl -L -s https://rev.ng/downloads/revng-distributable/master/install.sh | bash
|
|
```
|
|
|
|
You can now use `revng` as follows:
|
|
|
|
```{bash notest}
|
|
$ export PATH="$PATH:$PWD/revng"
|
|
$ revng artifact
|
|
```
|
|
|
|
Alternatively, you can set the environment so you don't need to do `./revng` bug just `revng`:
|
|
|
|
```{bash notest}
|
|
$ cd revng
|
|
$ source ./environment
|
|
$ revng artifact
|
|
```
|
|
|
|
Note that this second option will pollute a bit your environment. If that's not desirable for you, use the solution above.
|
|
|
|
### <a name="docker"></a>Using via Docker
|
|
|
|
We also offer a rev.ng container:
|
|
|
|
```{bash notest}
|
|
$ docker run --rm -it revng/revng
|
|
$ which revng
|
|
/revng/revng
|
|
```
|
|
|
|
The above command will work on macOS too, just sure you install [colima](https://github.com/abiosoft/colima).
|
|
|
|
If you're running on Apple Silicon, remember to specify the platform:
|
|
|
|
```{bash notest}
|
|
$ docker run --platform linux/amd64 --rm -it revng/revng
|
|
```
|
|
|
|
## Installing rev.ng as a developer
|
|
|
|
In order to get a working development environment, you need to install our package manager, orchestra.
|
|
|
|
First of all, let's clone the orchestra configuration:
|
|
|
|
```{bash noorchestra}
|
|
$ git clone https://github.com/revng/orchestra
|
|
Cloning into 'orchestra'...
|
|
$ cd orchestra
|
|
```
|
|
|
|
Let's now install the actual package manager application, `revng-orchestra`.
|
|
<br />You can either install it globally for the current user or in a virtualenv.
|
|
|
|
```{bash notest title="Install globally for the current user"}
|
|
$ python3 -m pip install --user --force-reinstall https://github.com/revng/revng-orchestra/archive/master.zip
|
|
$ export PATH="$HOME/.local/bin:$PATH"
|
|
```
|
|
|
|
```{bash title="Install in a virtualenv" notest}
|
|
$ python -m venv venv
|
|
$ source venv/bin/activate
|
|
$ pip install --upgrade pip wheel certifi
|
|
$ pip install https://github.com/revng/revng-orchestra/archive/master.zip
|
|
```
|
|
|
|
At this point, from the `orchestra` repository, we can sync all the information with the remote repositories:
|
|
|
|
```{bash silent}
|
|
$ orc update
|
|
```
|
|
|
|
To install `revng` and its dependencies from the binary archives run the following command:
|
|
|
|
```{bash notest}
|
|
$ orc install revng
|
|
```
|
|
|
|
Now you can enter the environment where you can use `revng`:
|
|
|
|
```{bash notest}
|
|
$ orc shell
|
|
$ revng artifact
|
|
```
|
|
|
|
The rest of the documentation assumes you're in an `orc shell`.
|
|
|
|
### Building from source
|
|
|
|
In order to build from source, add the following to `.orchestra/config/user_options.yml`:
|
|
|
|
```diff
|
|
--- a/.orchestra/config/user_options.yml
|
|
+++ b/.orchestra/config/user_options.yml
|
|
@@ -11,6 +11,6 @@
|
|
binary_archives:
|
|
- origin: "https://rev.ng/gitlab/revng/binary-archives.git"
|
|
|
|
-#! #@overlay/replace
|
|
-#! build_from_source:
|
|
-#! - component-name
|
|
+#@overlay/replace
|
|
+build_from_source:
|
|
+ - revng
|
|
```
|
|
|
|
We can now install and test `revng`:
|
|
|
|
```{bash notest}
|
|
$ orc install --test revng
|
|
```
|
|
|
|
This will clone the sources into `sources/revng`, build them, install them (in `root/`) and run the test suites.
|