armbian/configurator
0
0
Fork 0
mirror of https://github.com/armbian/configurator.git synced 2026-01-06 10:36:02 -08:00
Code Issues Packages Projects Releases Wiki Activity

I should stop using Kate for editing Markdown files

Browse Source 
This retarded editor will delete spaces at the end of
Markdown lines EVEN WHEN ASKED TO NEVER DO IT !
Two spaces to create a line-break in Markdown is
PART OF THE SYNTAX !

So, I'm now switching to Code for Markdown.

Signed-off-by: Myy Miouyouyou <myy@miouyouyou.fr>
This commit is contained in:
Myy Miouyouyou
2022-08-07 16:44:24 +02:00
parent 589db6f514
commit e2c72a828b
1 changed files with 19 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
DESIGN.md
View File

@@ -13,40 +13,39 @@ for packaging.
## Coding your own CLI module
1. Create a directory where you'll put the CLI module code and `cd` into it.
Example :
1. Create a directory where you'll put the CLI module code and `cd` into it.
Example :
```bash
mkdir -p ~/Documents/my_armbian_module
cd ~/Documents/my_armbian_module
```
2. Create a file named `DESC` and write a short description
for this module.
2. Create a file named `DESC` and write a short description for this module.
```bash
echo "Best module ever" > DESC
```
3. Add a `module` file and ensure it is executable. This file
will be the one executed by the configurator when running
your module.
3. Add a `module` file and ensure it is executable.
This file will be the one executed by the configurator when running
your module.
```bash
echo '#!/bin/bash' > module
echo "echo 'I told you, best module ever \!'" >> module
chmod +x module
```
4. Create the directory `/usr/share/armbian/configurator/modules/${module_name}/cli`
Example, if your module is named 'my_module' :
4. Create the directory `/usr/share/armbian/configurator/modules/${module_name}/cli`
Example, if your module is named 'my_module' :
```bash
module_name=my_module
sudo mkdir -p "/usr/share/armbian/configurator/modules/${module_name}"
```
5. Link the `DESC` file to `/usr/share/armbian/configurator/modules/${module_name}/DESC`
5. Link the `DESC` file to `/usr/share/armbian/configurator/modules/${module_name}/DESC`
```bash
module_name=my_module
sudo ln -s "${PWD}/DESC" "/usr/share/armbian/configurator/modules/${module_name}/DESC"
```
6. Link the directory itself to `/usr/share/armbian/configurator/modules/${module_name}/cli`
6. Link the directory itself to `/usr/share/armbian/configurator/modules/${module_name}/cli`
```bash
module_name=my_module
sudo ln -s "${PWD}" "/usr/share/armbian/configurator/modules/${module_name}/cli"
@@ -54,7 +53,7 @@ sudo ln -s "${PWD}" "/usr/share/armbian/configurator/modules/${module_name}/cli"
Now, the module is recognized by the configurator.
Launch the configurator without arguments to see your module in the list.
Launch the configurator without arguments to see your module in the list.
Launch the configurator with the name of your module to launch it :
```bash
@@ -76,20 +75,18 @@ You're done
## Adding a translation to the short description
To add a translation for a module description,
add a `DESC.{locale}` file to
`/usr/share/armbian/configurator/modules/${module_name}/`
To add a translation for a module description, add a `DESC.{locale}` file
to `/usr/share/armbian/configurator/modules/${module_name}/`
Precise locales are sampled before global ones, however
avoid using precise locales names when you can.
### Example
Let's say you want to add a French translation for a module
description.
Let's say you want to add a French translation for a module description.
French locales start with `fr`.
French locale for people living in France specifically is : `fr_FR`.
French locales start with `fr`.
French locale for people living in France specifically is : `fr_FR`.
French locale for people living in Canada specifically is : `fr_CA`.
So, if you want to add a french translation, add either a
@@ -97,17 +94,17 @@ So, if you want to add a french translation, add either a
If you add both `DESC.fr_FR` and `DESC.fr`, the system will use :
* `DESC.fr_FR` for people using the `fr_FR` locale.
* `DESC.fr_FR` for people using the `fr_FR` locale.
* `DESC.fr` for people using `fr_CA` locale.
If you only add `DESC.fr`, the system will use :
* `DESC.fr` for people using the `fr_FR` locale.
* `DESC.fr` for people using the `fr_FR` locale.
* `DESC.fr` for people using `fr_CA` locale.
if you only add `DESC.fr_FR`, the system will use :
* `DESC.fr_FR` for people using the `fr_FR` locale.
* `DESC.fr_FR` for people using the `fr_FR` locale.
* `DESC` (default english version) for people using the `fr_CA` locale.
## Prepare for packaging