https://github.com/jomy10/beaver
Simple, reliable and capable build system and command runner for any project
https://github.com/jomy10/beaver
build build-system build-tool cmake command-runner cross-platform make ruby
Last synced: 4 months ago
JSON representation
Simple, reliable and capable build system and command runner for any project
- Host: GitHub
- URL: https://github.com/jomy10/beaver
- Owner: Jomy10
- License: mit
- Created: 2022-08-15T14:52:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-11T20:22:11.000Z (12 months ago)
- Last Synced: 2025-02-11T21:27:06.367Z (12 months ago)
- Topics: build, build-system, build-tool, cmake, command-runner, cross-platform, make, ruby
- Language: Swift
- Homepage:
- Size: 620 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Beaver
Capable build system and command runner for any project.
Projects can be built programmatically because configuration is written in Ruby.
It is an excellent replacement for make and cmake. Beaver also integrates with
other build systems so you can have dependencies that use other build systems.
## Example
```ruby
Project(name: "Game")
C::Library(
name: "Physics",
description: "Physics simulation library",
language: :cpp,
sources: "lib/physics/*.cpp",
include: "include/physics"
)
C::Library(
name: "Renderer",
language: :c,
sources: "lib/renderer/*.c",
include: "include/renderer",
dependencies: [
pkgconfig("SDL2"),
system_lib("pthread")
]
)
C::Executable(
name: "Game",
language: :cpp,
sources: "src/*.cpp",
dependencies: ["Physics", "Renderer"]
)
```
## Building
Building requires **ruby** to be installed. The ruby version linked to will be the one that is accessible
from the command line `ruby --version`.
```sh
cargo build -p beaver-cli
```
## Installing
**from source**
```sh
cargo +nightly install --git https://github.com/jomy10/beaver
```
## Documentation
You can view the [examples](examples) and there is basic documentation in the [docs](docs) directory.
More extensive documentation is coming soon when the project is more stable.
## Contributing
Feel free to open an issue regarding bugs or improvements. If you want to work
on an improvement, you can do so by commenting on its issue and opening a pull
request. Your help is much appreciated!
### Running tests
Be sure to check your changes with tests. Add new ones if your change is not coverd by the current tests.
```sh
cargo test
```
## Questions
Feel free to ask any questions you may have by opening an issue.
## License
This software is licensed under the [MIT](LICENSE) license.
## References
- ["Correct, Efficiant and Tailored: The Future of Build Systems" by Guillaume Maudoux and Kim Mens, Université catholique de Louvain, Journal of Software Engineering.](https://dial.uclouvain.be/pr/boreal/object/boreal%3A189586/datastream/PDF_01/view)
- ["Build System Rules and Algorithms" by Mike Shal, 2009.](https://gittup.org/tup/build_system_rules_and_algorithms.pdf)