Skip to content

Commit f84f0ce

Browse files
partipan-dotschrnz
authored andcommitted
Add README to repo
1 parent 378b0b6 commit f84f0ce

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# ARTist-SDK
2+
The ARTist let's you build modules for ARTist without needing to download and set up AOSP. The SDK contains everything that's needed to build a module from your source code.
3+
4+
## Fetching from AOSP
5+
This repo uses the `src/fetch.sh` bash script to pull out the needed files from an AOSP build server. To use the bash script we need to create a config file `~/.artist-sdk/ssh-config`.
6+
It looks like this:
7+
```
8+
ssh_identity="identity"
9+
aosp_root_path="~/aosp_root_dir/"
10+
```
11+
The `ssh-identity` refers to your `.ssh/config` file and `aosp_root_path` to your AOSP directory on your build server.
12+
If you need to setup your `.ssh/config` file look into the [man pages](https://linux.die.net/man/5/ssh_config).
13+
14+
## Build sdk.zip
15+
1. `make zip`
16+
17+
## Build Debian package (.deb)
18+
1. `sudo apt-get install build-essential debhelper`
19+
2. `make deb`
20+
3. `sudo dpkg -i releases/artist-sdk_w.x.y-z_amd64.deb` (install sdk [optional])
21+
22+
## Build Fedora/CentOS package (.rpm)
23+
1. `sudo dnf install rpm-build`
24+
2. `make rpm`
25+
3. `sudo dnf install releases/artist-sdk-w.x.y-z.fcxx.x86_64.rpm` (install sdk [optional])

0 commit comments

Comments
 (0)