bmde 1.10.0

Bare Metal Development Environment CLI; for NDS development for the practical exercises of Computers

Bare Metal Development Environment (BMDE) CLI

CLI wrapping the Bare Metal Development Environment (BMDE)
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • General features
     • Naive components
     • One module wraps one software
     • Flexibility using backend
     • Config and arguments
     • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Use
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Operating system agnostic CLI wrapping the Bare Metal Development Environment (BMDE) and other related utilities to manage the complete software life-cycle of a NDS C and / or assembly project using either host or Dockerized installations of the software components of the BMDE, plus opinionated features to be used in the development of the practical exercises from the subject Computers, Operating Systems Structure and in minor cases Computer Fundamentals from the university degree of Computer Engineering in the University Rovira i Virgili (URV).

(back to top)

General features

Naive components

Each component is independent and can be used individually without using bmde.

One module wraps one software

Each module corresponds to a wrapper around one software and its environment.

Flexibility using backend: Docker vs host (or others)

Each module can be executed using as entrypoint the corresponding binary in your machine (host) or a binary provided by Docker embedded in bmde. This allows using bmde but either using a Docker installation that is already provided, or your own host installations. You can do this for each module (WIP).

In the same sense, some additional backends may be provided, for example, the run command which wraps desmume, also provides the FlatHub (flathub) backend.

Config and arguments

A native toml schema is included to provide default values to arguments to bmde. bmde also reads configuration from various sources with different priority, allowing for fine-grained control over each repository. The priority is the following, with later mentioned sources overriding previous:

• Environment variables.
• /etc/bmde/bmde.toml
• ~/.config/bmde/bmde.toml
• Closest bmde.toml upward in the tree
• Explicit configuration via arguments pointing to a valid .toml file.

The configuration files allows an easy usage to bmde: Provided arguments via config files can be omitted from the arguments of the CLI call to bmde, allowing shorter commands and skipping the need to provide things like credentials for authentication in each call to bmde.

Default arguments can be customized via (from less to more priority) system variables, global configuration file, specific configuration file of the repo, specific configuration args for the execution.

(back to top)

Built With

This section lists any major languages/frameworks/libraries/tools used in this project.

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

(back to top)

Getting Started

Prerequisites

To run bmde you will need Python 3.11 installed in your system.

To run a command you will need either Docker with permissions for the user executing bmde COMMAND or the software that the command wraps directly installed in your system. For simplicity, we recommend sticking to Docker.

Check out the docs for a full explanation on the prerequisites.

Installation

Install the command by using:

pip install bmde

You may add an alias to your binary to shorten up the command from python -m bmde to bmde:

echo "alias bmde=python -m bmde" >> ~/.bashrc

Check out the docs for a full explanation on the installation.

Usage

You can start using BMDE by cloning a NDS project:

bmde git clone [e-mail]:comp_20

Then, enter the directory of the repository you just cloned:

cd comp_20

And build the project with:

bmde build

If the building is successful you will be able to run the project with:

bmde run

Check out the docs for a full explanation on the usage.

(back to top)

Roadmap

See the project roadmap for a full list of proposed features, and known issues and its implementation state).

(back to top)

Contributing

Check out our CONTRIBUTING.md to know how to make a contribution.

Top contributors:

(back to top)

License

Proudly distributed with love under the GNU GPLv3 License. See LICENSE for more information.

(back to top)

Contact

@AleixMT - [e-mail]

(back to top)

Acknowledgments

The teachers of URV who have collaborated.

(back to top)