Add MkDocs first version

This commit is contained in:
Lukas Schmid 2024-04-25 09:35:35 +02:00
parent 77d6ceb540
commit 94ed7e1b37
8 changed files with 145 additions and 23 deletions

View File

@ -5,28 +5,16 @@
# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
# Set the version of Python and other tools you might need
# build:
# os: ubuntu-22.04
# tools:
# python: "3.10"
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
mkdocs:
configuration: mkdocs.yml
# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt

63
docs/#buildroot-setup.md Normal file
View File

@ -0,0 +1,63 @@
# Buildroot Setup
## Introduction
In this section, we'll guide you through the process of cloning the Git repository containing the source for Buildroot and creating your first build for the Kumquat board. Follow these steps to customize and build your own Linux image for your Kumquat board.
## Prerequisites
Before proceeding, ensure that you have:
- A computer running a Debian-based distribution or Windows Subsystem for Linux 2 (WSL2) with a Debian-based distro.
- Installed the following packages using apt:
```shell
sudo apt update
sudo apt install -y sed make binutils build-essential diffutils gcc g++ bash patch gzip bzip2 perl tar cpio unzip rsync file bc findutils wget git
```
## Step 1: Clone Buildroot Repository
1. Open a terminal on your computer.
2. Clone the Buildroot repository by running the following command:
```shell
git clone https://git.netcubesystems.at/NetCube-Systems-Austria/kumquat-buildroot.git
```
![Clone Repository](img/buildroot-setup/clone-repo.png)
## Step 2: Configure the Build
1. Change directory into the newly cloned Git folder:
```shell
cd kumquat-buildroot
```
2. Configure the Buildroot project for the Kumquat board by running:
```shell
make netcube_kumquat_defconfig
```
![Select Configuration](img/buildroot-setup/make-defconfig.png)
## Step 3: Build the Image
1. Start the build process by running:
```shell
make
```
2. The build process will take some time (could be a few hours depending on your system's performance). Monitor the progress in the terminal.
## Step 4: Obtain the Built Image
1. Once the build finishes, navigate to the output/images folder within the Buildroot directory.
2. You will find a new file named "sdcard.img". This is your custom-built Linux image for the Kumquat board.
![Built Image](img/buildroot-setup/image-file.png)
## Step 5: Customize the Build (Optional)
1. If you wish to customize the Buildroot installation, run:
```shell
make menuconfig
```
![Buildroot Menuconfig](img/buildroot-setup/menuconfig.png)
2. Make your desired changes in the configuration menu.
3. After making changes, save the configuration and run `make` again to create a new "sdcard.img".
## Conclusion
Congratulations! You have successfully cloned the Buildroot repository, configured your first build for the Kumquat board, and created a custom Linux image. Feel free to explore further customization options using Buildroot's documentation available at [Buildroot Manual](https://buildroot.org/downloads/manual/manual.html).

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

55
docs/quickstart.md Normal file
View File

@ -0,0 +1,55 @@
# Kumquat Quickstart Guide
## Introduction
Welcome to the quickstart guide for the Kumquat by NetCube Systems! This guide will walk you through the initial setup process to get your board up and running quickly. Whether you're a novice or an advanced user, follow these steps to start exploring the capabilities of your Kumquat board.
## Prerequisites
Before you begin, make sure you have the following:
- Kumquat board
- Kumquat Flash Adapter
- USB Type-C cable
- 12V or 24V power supply (with at least 1A of power)
- Computer capable of running a serial terminal application
- Micro-SD card and card reader
## Step 1: Prepare the SD Card
1. Insert the SD card into the card reader of your computer.
## Step 2: Download and Write Buildroot Image
1. Download the latest example Buildroot image [here](https://git.netcubesystems.at/NetCube-Systems-Austria/kumquat-docs/src/branch/master/builds/netcube_kumquat_defconfig).
2. Use Balena Etcher (or similar tool) to write the Buildroot image to the SD card.
## Step 3: Insert SD Card into Kumquat Board
1. Eject the SD card from your computer.
2. Insert the SD card into the "Flash Module Adapter" provided with the Kumquat board.
3. Insert the adapter into the top right pin header just below the audio connectors on the Kumquat board.
![Insert Adapter](placeholder_image_link)
## Step 4: Connect USB Cable
1. Connect one end of the USB cable to the right port of the Kumquat board.
2. Insert the other end of the USB cable into an available USB port on your computer.
![Connect USB Cable](placeholder_image_link)
## Step 5: Open Serial Terminal
1. Open a serial terminal application such as PuTTY or GtkTerm on your computer.
2. Select the newly detected serial port with the following settings:
- Baud rate: 115200
- Data bits: 8
- Parity: None
- Stop bits: 1
## Step 6: Connect Power Supply
1. Connect the 12V or 24V power supply to the bottom right terminal block of the Kumquat board.
2. Ensure that the positive pin of the power connector is on the right side.
![Connect Power Supply](placeholder_image_link)
## Step 7: Boot up the Kumquat Board
1. Check the serial console for output.
2. You should see the start sequence: U-Boot Bootloader, followed by the Buildroot Operating System.
3. After a few seconds, you should be prompted with a login. You can log in with the username `root`.
## Conclusion
Congratulations! You have successfully set up your NetCube Systems Kumquat. Start exploring and experimenting with its capabilities. Refer to the next pages for more advanced usage and customization options.

16
mkdocs.yml Normal file
View File

@ -0,0 +1,16 @@
site_name: Kumquat Documentation
theme:
name: readthedocs
highlightjs: true
plugins:
- search
- mkdocstrings:
handlers:
# See: https://mkdocstrings.github.io/python/usage/
python:
options:
docstring_style: sphinx
markdown_extensions:
- markdown_include.include:
base_path: .
- admonition