Skip to content

Commit 7af9185

Browse files
committed
README.md: various edits
Worked on formatting, grammar, etc. Also added myself to credits.
1 parent 1f5b97e commit 7af9185

File tree

1 file changed

+33
-27
lines changed

1 file changed

+33
-27
lines changed

README.md

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,50 @@
1-
# Hyperion.NG for WebOS
1+
# Hyperion.NG for webOS
22

3-
Binaries are ready to install from [Homebrew Channel](https://repo.webosbrew.org/apps/org.webosbrew.hyperion.ng.loader)
3+
Binaries are [available](https://repo.webosbrew.org/apps/org.webosbrew.hyperion.ng.loader) through [Homebrew Channel](https://github.com/webosbrew/webos-homebrew-channel).
44

5-
## Requirements
5+
## Building
6+
7+
### Requirements
68

79
* Linux host system
8-
* WebOS buildroot toolchain - arm-webos-linux-gnueabi_sdk-buildroot (https://github.com/openlgtv/buildroot-nc4/releases)
9-
* git
10+
* [buildroot-nc4](https://github.com/openlgtv/buildroot-nc4/releases), a toolchain targeting webOS
11+
* Git
1012
* CMake
1113
* npm
1214

13-
## Build
14-
15-
Build hyperion.ng: `./build_hyperion_ng.sh`
16-
17-
Build webOS frontend/service: `./build.sh`
18-
19-
Both scripts take an environment variable `TOOLCHAIN_DIR`, defaulting to: `$HOME/arm-webos-linux-gnueabi_sdk-buildroot`
15+
### Instructions
2016

21-
To provide an individual path, call `export TOOLCHAIN_DIR=/your/toolchain/path` before executing respective scripts.
17+
Build Hyperion.NG:
18+
```
19+
./build_hyperion_ng.sh
20+
```
2221

23-
`build_hyperion_ng.sh` also takes two other environment variables:
22+
Build webOS frontend/service:
23+
```
24+
./build.sh
25+
```
2426

25-
- `HYPERION_NG_REPO`
26-
- `HYPERION_NG_BRANCH`
27+
Both scripts take the environment variable `TOOLCHAIN_DIR`, defaulting to `$HOME/arm-webos-linux-gnueabi_sdk-buildroot`.
2728

28-
## References
29+
To provide a different path, run `export TOOLCHAIN_DIR=/your/toolchain/path` before executing the respective scripts.
2930

30-
Ambient lighting service/daemon: [Hyperion.NG](https://github.com/hyperion-project/hyperion.ng)
31+
Two other environment variables can also be used to configure `build_hyperion_ng.sh`:
32+
- `HYPERION_NG_REPO` - Repository from which to obtain Hyperion.NG. Defaults to `https://github.com/hyperion-project/hyperion.ng`.
33+
- `HYPERION_NG_BRANCH` - Which branch to check out from the above repo. Defaults to `master`.
3134

32-
Video grabber of webOS: [hyperion-webos](https://github.com/webosbrew/hyperion-webos)
35+
## Related projects
3336

34-
Frontend of Video grabber hyperion-webos: [piccap](https://github.com/TBSniller/piccap)
37+
- [Hyperion.NG](https://github.com/hyperion-project/hyperion.ng) - Ambient lighting service/daemon
38+
- [hyperion-webos](https://github.com/webosbrew/hyperion-webos) - Video grabber for webOS
39+
- [PicCap](https://github.com/TBSniller/piccap) - Frontend for hyperion-webos video grabber
3540

3641
## Credits
3742

38-
@Smx-smx
39-
@TBSniller
40-
@Informatic
41-
@Mariotaku
42-
@Lord-Grey
43-
@Paulchen-Panther
44-
@chbartsch
43+
* @Smx-smx
44+
* @TBSniller
45+
* @Informatic
46+
* @Mariotaku
47+
* @Lord-Grey
48+
* @Paulchen-Panther
49+
* @chbartsch
50+
* [throwaway96](https://github.com/throwaway96)

0 commit comments

Comments
 (0)