peter/infix
1
0
Fork 0
mirror of https://github.com/kernelkit/infix.git synced 2026-07-29 20:23:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix #64: initial Developer's Guide

Browse Source 
Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
This commit is contained in:
Joachim Wiberg
2023-08-16 13:52:04 +02:00
committed by Tobias Waldekranz
parent 93db790de6
commit b480cd76f1
1 changed files with 52 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/developers-guide.md
+52 -3
View File
@@ -1,12 +1,29 @@
Developer's Guide
=================
Cloning
-------
Please see the [Contributing](#contributing) section, below, for details
on how to fork and clone when contributing to Infix.
```bash
$ mkdir ~/Projects; cd ~/Projects
$ git clone https://github.com/kernelkit/infix.git
$ cd infix/
$ git submodule update --init
```
Building
--------
Buildroot is almost stand-alone, it needs a few locally installed tools
to bootstrap itself. For details, see the [excellent manual][manual].
> **Note:** installation for Debian/Ubuntu based systems: <kbd>sudo apt
> install make libssl-dev</kbd>
Briefly, to build an Infix image; select the target and then make:
make x86_64_defconfig
@@ -20,10 +37,42 @@ To see available defconfigs for supported targets, use:
make list-defconfigs
> **Note:** build dependencies (Debian/Ubuntu): <kbd>sudo apt install make libssl-dev</kbd>
Testing
-------
Manual testing can be done using Qemu by calling <kbd>make run</kbd>,
see also [Infix in Virtual Environments](virtual.md).
The Infix automated test suite is built around Qemu and [Qeneth][2], see:
* [Testing](doc/testing.md)
* [Docker Image](test/docker/README.md)
[manual]: https://buildroot.org/downloads/manual/manual.html
Contributing
------------
Infix is built from many parts, when contributing you need to set up
your own fork, create a local branch for your change, push to your fork,
and then use GitHub to create a *Pull Reqeuest*.
[7]: https://github.com/wkz/qeneth
For this to work as painlessly as possible:
1. Fork Infix to your own user
2. Fork all the Infix submodules, e.g., `buildroot` to your own user
3. Clone your fork of Infix to your laptop/workstation
```bash
$ cd ~/Projects
$ git clone https://github.com/YOUR_USER_NAME/infix.git
$ cd infix/
$ git submodule update --init
```
> **Note:** when updating/synchronizing with upstream Infix changes you
> may have to synchronize your forks as well. GitHub have a `Sync fork`
> button in the GUI for your fork for this purpose.
[1]: https://buildroot.org/downloads/manual/manual.html
[2]: https://github.com/wkz/qeneth