Skip to content

Commit f94ba18

Browse files
Added more help to README
1 parent ae26138 commit f94ba18

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
11
# Oxygen
2+
# downloading and building dash
3+
git clone git://git.kernel.org/pub/scm/utils/dash/dash.git dash
4+
cd dash
5+
sh autogen.sh
6+
sh configure.sh --enable-static
7+
make
8+
# creating an enviroment for dash
9+
mkdir -p ../oxygen_dash/bin
10+
cp src/dash ../oxygen_dash/bin
11+
cd ..
12+
# now we download and install oxygen
13+
git clone https://github.com/paulo-e/oxygen oxygen
14+
cd oxygen
15+
RUSTFLAGS='-C target-feature=+crt-static' cargo install --path . --root=../oxygen_dash/
16+
cd ..
17+
sudo chroot oxygen_dash /bin/dash
218

319
[![Rust](https://github.com/paulo-e/oxygen/actions/workflows/rust.yml/badge.svg)](https://github.com/paulo-e/oxygen/actions/workflows/rust.yml)
420

@@ -9,8 +25,34 @@ Do as follows:
925
```sh
1026
git clone https://github.com/paulo-e/oxygen oxygen
1127
cd oxygen
12-
cargo build
28+
cargo build --release
29+
# now all the programs are in ./target/release
30+
ls ./target/release
31+
# you can also install the files (default path is $HOME/.cargo/bin) with
32+
cargo install --path .
33+
```
34+
35+
## Testing
36+
Optionally, you can test the userspace on a controlled enviroment
37+
38+
``` sh
39+
# downloading and building dash git clone git://git.kernel.org/pub/scm/utils/dash/dash.git dash
40+
cd dash
41+
sh autogen.sh
42+
sh configure.sh --enable-static
43+
make
44+
# creating an enviroment for dash
45+
mkdir -p ../oxygen_dash/bin
46+
cp src/dash ../oxygen_dash/bin
47+
cd ..
48+
# now we download and install oxygen
49+
git clone https://github.com/paulo-e/oxygen oxygen
50+
cd oxygen
51+
RUSTFLAGS='-C target-feature=+crt-static' cargo install --path . --root=../oxygen_dash/
52+
cd ..
53+
sudo chroot oxygen_dash /bin/dash
54+
# now you can try all the installed programs
1355
```
1456

15-
# License
57+
## License
1658
[It's the BSD 3-clause license](https://github.com/paulo-e/oxygen/blob/master/LICENSE)

0 commit comments

Comments
 (0)