Skip to content
This repository has been archived by the owner on Jan 4, 2024. It is now read-only.

Commit

Permalink
docs: update README.md with basic installation and usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
antoinevg committed Nov 29, 2021
1 parent b041f30 commit eee4983
Showing 1 changed file with 51 additions and 8 deletions.
59 changes: 51 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,63 @@ Remember to add the following to your shell startup script: (`~/.zshenv` for `zs

pip install -r generate/requirements.txt

### Install `forge-*` commands:

cd librewolf.git/generate
pip install -r requirements.txt
python setup.py develop

### Configure installation:

Requires python 2.7 and virtualenv::
Link module directory:

virtualenv ./python-env
source python-env/bin/activate ("python-env/Scripts/activate.bat" on windows)
cd generate
pip install -r requirements.txt
python setup.py develop
cd librewolf.git
ln -s ../modules ./modules.local

Create a new file: `librewolf.git/system_config.json`

{
"android_sdk_root": "/mnt/android-sdks",
"android_sdk_dir": "/mnt/android-sdks/api-30",
"module_urls": "https://s3.amazonaws.com/trigger-module-build/%s/%s.zip",
}

Create or copy `local_config.json`:

cd librewolf.git
cp path/to/your/app/local_config.json path/to/libreforge.git/local_config.json


## Commands

All commands have their own help, run with -h for detaisl
All commands have their own help, run with -h for details:

* `forge-generate` - build or package an app
* `forge-inspector` - generates or re-generates a module's inspector app
* `forge-module-test-app` - generates an app that will run module tests


### `forge-generate`

To build an app:

export PLATFORM=android
export PROJECT=vanilla

forge-generate build -p -v --platforms $PLATFORM \
--config ~/forge-workspace/$PROJECT/src/config.json \
--usercode ~/forge-workspace/$PROJECT/src \
--userassets ~/forge-workspace/$PROJECT/assets \
--override_modules modules.local \
--temp=/tmp/libreforge \
--output ~/forge-workspace/$PROJECT

To package an app:

`forge-generate`, `forge-inspector`, `forge-module-test-app`
forge-generate build package -p -v --platforms $PLATFORM \
--config ~/forge-workspace/$PROJECT/src/config.json \
--usercode ~/forge-workspace/$PROJECT/src \
--userassets ~/forge-workspace/$PROJECT/assets \
--override_modules modules.local \
--temp=/tmp/libreforge \
--output ~/forge-workspace/$PROJECT

0 comments on commit eee4983

Please sign in to comment.