FWGS/waifu
2
0
Fork 0
Code Issues Pull Requests Releases 2 Wiki Activity

readme: update [ci skip]

Browse Source
This commit is contained in:
Alibek Omarov 2019-06-07 02:44:28 +03:00 committed by GitHub
parent 7cbe38e723
commit 476915675e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,6 +1,6 @@
# Waifu Build System
This is a fork of Waf build system. It's not a complete build system, though.
This is a Waf build system with some experimental modules developed for FWGS projects.
This repo is focused on developing our own modules, testing them, syncing with upstream and maybe sending back patches to original Waf in future.
@ -8,17 +8,21 @@ This repo is focused on developing our own modules, testing them, syncing with u
We add some additional tools from original Waf extras and prelude to load waifulib is added.
You can use `build-waf.sh` shell script(TODO: move to wscript) either prebuilt `waf` from this root repo
To build use `build-waf.sh` shell script
## Running tests
They are enabled by default. Just run:
```
$ waf configure build
$ sh run-tests.sh
```
If it succeded, then tests are not failed.
## Using in your project
Copy `scripts` and generated/prebuilt `waf` file to your project
There is two prebuilt waf binaries, to those who don't want build by themselves.
1) `waf-ext` as a prebuilt waf binary with some of our modules
2) `waf-noext` as a prebuilt vanilla waf binary, only with line of code, to preload waifulib
Then you need to create `scripts/waifulib` folder where you will place `waf` binary.
Depending on your needs, copy modules from our `scripts/waifulib` folder to yours.