51 lines
No EOL
1.7 KiB
Markdown
51 lines
No EOL
1.7 KiB
Markdown
# test-package
|
|
|
|
## Usage
|
|
|
|
Simple package to test both eternity and eon
|
|
|
|
Build with
|
|
|
|
```
|
|
eternity build
|
|
```
|
|
|
|
Install with
|
|
|
|
```
|
|
eon install <output file>.epk
|
|
```
|
|
|
|
## The eternity.json file
|
|
|
|
The `eternity.json` file contains various options to configure the build and metadata of the package. Below is a breakdown of the available options:
|
|
|
|
### metadata
|
|
|
|
- **author**: The author of the package. Example: `"Example"`
|
|
- **name**: The name of the package. Example: `"test-package"`
|
|
- **desc**: A short description of the package. Example: `"A wonderful test package"`
|
|
- **longDesc**: A detailed description of the package. Example: `"A very wonderful package\nWith a very long\nDescription!"`
|
|
- **version**: The version of the package. Example: `"1.0.2"`
|
|
- **license**: The license under which the package is distributed. Example: `"MIT"`
|
|
- **arch**: The architecture for which the package is built. Example: `"x86_64"`
|
|
- **deps**: A list of dependencies required by the package. Example: `[]`
|
|
- **specialFiles**: Special files that have specific handling rules.
|
|
- **noDelete**: Files that should not be deleted. Example: `["/etc/config.conf"]`
|
|
- **noReplace**: Files that should not be replaced. Example: `["/var/hi/cache.thing"]`
|
|
|
|
### build
|
|
|
|
- **type**: The type of build environment. Example: `"host"`
|
|
- **deps**: A list of build dependencies. Example: `[]`
|
|
- **steps**: The steps to build the package.
|
|
- Example:
|
|
```json
|
|
[
|
|
"g++ -c src/main.cpp -o main.o",
|
|
"mkdir -p build/usr/bin",
|
|
"g++ main.o -o build/usr/bin/test-package"
|
|
]
|
|
```
|
|
- **root**: The root directory for the build output. Example: `"build"`
|
|
- **files**: The directory containing the source files. Example: `"src"` |