diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..9883a75d --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Justbuild + +Justbuild is a generic build system supporting multi-repository +builds. A pecularity of the tool is the separation between global +names and physical location on the one hand, and logical paths +used for actions and installation (sometimes referred to as +"staging"). Language-specific information to translate high-level +concepts (libraries, binaries) into individual compile action is +taken from user-defined rules described by functional expressions. + +## Getting Started + +* The most simple way to build the `just` binary from scratch + is `python3 ./bin/bootstrap.py`. For more details see the + [installation guide](INSTALL.md). + +* Tutorial + - [Hello World](doc/tutorial/hello-world.org) + - [Third party dependencies](doc/tutorial/third-party-software.org) + - [Tests](doc/tutorial/tests.org) + - [Using protobuf](doc/tutorial/proto.org) + +## Documentation + +- [Overview](doc/concepts/overview.org) +- [Build Configurations](doc/concepts/configuration.org) +- [Multi-Repository Builds](doc/concepts/multi-repo.org) +- [Expression Language](doc/concepts/expressions.org) +- [Built-in Rules](doc/concepts/built-in-rules.org) +- [User-Defined Rules](doc/concepts/rules.org) +- [Documentation Strings](doc/concepts/doc-strings.org) +- [Cache Pragma and Testing](doc/concepts/cache-pragma.org) +- [Anonymous Targets](doc/concepts/anonymous-targets.org) +- [Target-Level Caching](doc/concepts/target-cache.org) |