fix: Fix documentation and add folder for artwork (osl-incubator#70)

.makim.yaml

@@ -24,11 +24,12 @@ groups:
       build:
         help: Build documentation
         run: |
-          mkdocs build --config-file docs/mkdocs.yaml
+          mkdocs build --config-file mkdocs.yaml
 
       preview:
         help: Preview documentation page locally
-        run: mkdocs serve --watch docs --config-file docs/mkdocs.yaml
+        run: |
+          mkdocs serve --watch docs --config-file mkdocs.yaml
 
   release:
     vars:

README.md

@@ -1,35 +1,37 @@
-# MakIm
+# Get Started
 
-`MakIm` or just `makim` is based on `make` and focus on improve
-the way to define targets and dependencies. Instead of using the
-`Makefile` format, it uses `yaml` format.
+`MakIm` or just `makim` is based on `make` and focus on improve the way to
+define targets and dependencies. Instead of using the `Makefile` format, it uses
+`yaml` format.
 
-The idea of this project is to offer a way to define targets and
-dependencies with some control options, like conditionals `if`.
+The idea of this project is to offer a way to define targets and dependencies
+with some control options, like conditionals `if`.
 
-It allows a very easy way to define texts for documentation and
-extra parameters for each target.
+It allows a very easy way to define texts for documentation and extra parameters
+for each target.
 
-
-* Free software: BSD 3 Clause
-* Documentation: https://osl-incubator.github.io/makim
+- License: BSD 3 Clause
+- Documentation: https://osl-incubator.github.io/makim
 
 ## Features
 
-* Help text as first-class in the `.makim.yaml` specification. It can be used by targets and arguments.
-* Targets have an option for arguments.
-* Targets have an option for dependencies.
-* Dependencies can call a target with specific arguments.
-* Dependencies can have a conditional control flow (`if`).
-* Allow the creation of groups, so the targets can be organized by topics.
-* Targets and groups have an option for user defined variables and/or environment variables.
-* Access arguments, variables or environment variables via template (using Jinja2).
-* Option for using dot environment files using `env-file` key.
+- Help text as first-class in the `.makim.yaml` specification. It can be used by
+  targets and arguments.
+- Targets have an option for arguments.
+- Targets have an option for dependencies.
+- Dependencies can call a target with specific arguments.
+- Dependencies can have a conditional control flow (`if`).
+- Allow the creation of groups, so the targets can be organized by topics.
+- Targets and groups have an option for user defined variables and/or
+  environment variables.
+- Access arguments, variables or environment variables via template (using
+  Jinja2).
+- Option for using dot environment files using `env-file` key.
 
 ## How to use it
 
-First you need to place the config file `.makim.yaml` in the root of your project.
-This is an example of a configuration file:
+First you need to place the config file `.makim.yaml` in the root of your
+project. This is an example of a configuration file:
 
 ```yaml
 version: 1.0.0
@@ -64,15 +66,11 @@ groups:
 
 Some examples of how to use it:
 
-* run the `build` target:
-  `makim build`
-
-* run the `clean` target:
-  `makim clean`
+- run the `build` target: `makim build`
 
-* run the `build` target with the `clean` flag:
-  `makim build --clean`
+- run the `clean` target: `makim clean`
 
+- run the `build` target with the `clean` flag: `makim build --clean`
 
 The help menu for the `.makim.yaml` file would looks like this:
 
@@ -84,15 +82,16 @@ MakIm is a tool that helps you to organize and simplify your helper commands.
 
 positional arguments:
   target
-    Specify the target command to be performed.
-    Options are:
+    Specify the target command to be performed. Options are:
+
+    default:
+    --------
       default.clean => Use this target to clean up temporary files
         ARGS:
           --all: (bool) Remove all files that are tracked by git
       default.build => Build the program
         ARGS:
           --clean: (bool) if not set, the clean dependency will not be triggered.
-    NOTE: 'default.' prefix is optional.
 
 options:
   --help, -h
@@ -105,59 +104,5 @@ options:
 If you have any problem, open an issue at: https://github.com/osl-incubator/makim
 ```
 
-As you can see, the help menu automatically adds information defined by all
-the `help` key, inside the `.makim.yaml` file.
-
-## Xonsh Shell Integration
-
-### What is Xonsh?
-[Xonsh](https://xon.sh/) is a powerful shell language and command prompt designed to
-seamlessly blend traditional shell capabilities with the expressive syntax of Python.
-  It offers an interactive and extensible environment that enables users to transition 
-  effortlessly between standard shell commands and Python scripting.
-
-### How Xonsh enhances this Project?
-In the context of this project, Xonsh serves as the default shell for executing commands 
-defined in the Makim configuration. By leveraging Xonsh, the Makim tool gains the flexibility 
-and richness of the Python programming language within a command-line interface. This integration 
-allows users to create sophisticated tasks and harness the full power of Python directly 
-in the terminal.
-
-### Key Features and Commands in Xonsh
-1. **Unified Syntax :** Xonsh seamlessly integrates traditional shell syntax with Python's 
-clean and expressive syntax, creating a unified and consistent scripting experience.
-```
-# Shell-style command
-ls -l
-
-# Python-style variable assignment
-$filename = "example.txt"
-
-# Combining both in a single command
-echo "The contents of $filename are: $(cat $filename)"
-```
-
-2. **Python Variables and Expressions :** Python variables can be easily incorporated into 
-commands, enhancing the readability and flexibility of your scripts.
-```
-$filename = "example.txt"
-echo "The filename is $filename"
-```
-
-3. **Looping and Conditional Statements :** Use Python-style loops and conditionals to create 
-dynamic and complex command sequences.
-```
-for $i in range(3):
-    echo "Iteration $i"
-```
-
-4. **Extensible Tab Completion :** Xonsh offers extensible and intelligent tab completion, 
-making it easier to discover and complete commands and variables.
-```
-$long_variable_name = "some_value"
-echo $long_<TAB>
-# Xonsh will intelligently complete the variable name
-```
-
-For more comprehensive information and documentation, explore the [Xonsh GitHub repository]
-(https://github.com/xonsh/xonsh) and the official [Xonsh website](https://xon.sh/).
+As you can see, the help menu automatically adds information defined by all the
+`help` key, inside the `.makim.yaml` file.