Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added the foreword and 1st chapter of nbuild gs #9

Open
wants to merge 4 commits into
base: nbuild
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions nbuild/00.Foreword.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Foreword
Welcome to Nest build's official getting-started guide!

Nest build, or `nbuild`, is an automated package builder for [Raven-OS](https://raven-os.org), which is an adaptative, customizable and evolutive open-source Operating System (OS) based on the Linux kernel.
`nbuild` can be run on any linux-based distribution.
Pedrochu marked this conversation as resolved.
Show resolved Hide resolved

## Documentation
`nbuild`'s documentation is hosted [here](https://docs.raven-os.org/nbuild/master), but it can also be locally generated with the following commands:
Pedrochu marked this conversation as resolved.
Show resolved Hide resolved
```
$ pip install -r docs/requirements.txt
$ sphinx-apidoc -f --separate -o docs/source/ .
$ make -C docs html
```
The main page can be accessed at `docs/build/html/index.html`.

## Getting help
If you need help, you can join our official [community Discord server](https://invite.gg/ravenos) and ask any question you have there. Our team and community will be glad to answer them.
20 changes: 20 additions & 0 deletions nbuild/01.nbuild.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 1 ``nbuild``
## 1.1 What `nbuild` is for
[//]: # (TODO: Add link to the getting-started for Nest)
`nbuild` is an automated package builder.
From a build manifest and source code, `nbuild` will abstract the build system used (cmake, autoconf, etc.), compile the software, get the executable files and files to install (binaries, libraries, manual pages, etc.) and wrap them in a package that Nest will know how to install: a `.nest` archive, called an npf file.
Pedrochu marked this conversation as resolved.
Show resolved Hide resolved
It contains a `data.tar.gz` with all the files to install, if there are any, and a build manifest `manifest.toml`, containing basic information and metadata for this software (its name, version, description, licenses, etc.).

All of this is done thanks to a powerful library included in `nbuild`: the standard compilation library, for which you can find the documentation [here](https://docs.raven-os.org/nbuild/master/stdlib.html).

`nbuild` requires python3.6+ to run, and you will first need to install `nbuild`'s dependencies by running `pip install -r requirements.txt`.
Pedrochu marked this conversation as resolved.
Show resolved Hide resolved

## 1.2 How to use `nbuild`
There are several flags for `nbuild`:
* `--config CONFIG` allows you to change the static configuration file for `nbuild`.
By default, it's `config.toml`.
* `-o OUTPUT_DIR` or `--output-dir OUTPUT_DIR` changes the output directory for the built packages.
By default, it's `packages/`.
* `-c CACHE_DIR` or `--cache-dir CACHE_DIR` changes the cache directory used when downloading and building packages.
By default, it's `cache/`
* `--purge` removes all cached data.