Logo
MidOS Mid Layer

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Project Help
• Contributing
• Acknowledgements
  • Sponsors, Donations, and Patrons
  • Software Used
  • Inspirations
  • Authors & Contributors
• Security
• License

About

In today's era where technology is heavily integrated into society, the operating system has become a critical and irreplaceable tool to the world and an essential part of our daily lives. MidOS is a pre-configured, overridable, disableable, modular operating system with sane defaults for anyone based on NixOS. The time for half-measures and empty promises is over.

For more information, please see the MidOS manifesto.

Back to top

Getting Started

Prerequisites

To view the prerequisite instructions, please view here.

Installation

To view the installation instructions, please view here.

Back to top

Usage

Note: In the future, there will be a graphical system preferences application to help configure, update, and customize MidOS that should be user friendly enough for the every day user. (including people that have never used linux before)

The general workflow for using MidOS goes as follows:

1. Search the MidOS Options Docs if a MidOS option exists for what you want.
2. If so, enable and/or configure the option in ~/.config/mid-os/mid.nix.
3. If not, check the NixOS Options Search, and you can request the option by creating an issue.
4. If so, enable and/or configure the option in ~/.config/mid-os/configuration.nix.
5. If not, check whether there is a corresponding Nix package.
6. If so, add the package to the packages option in ~/.config/mid-os/mid.nix.
7. If not, make an issue to nixpkgs to request the package.

After configuring, run:

rebuild

For manually adding or configuring options, see the for a full list of a available options.

Back to top

Roadmap

See the open issues for a list of proposed features and known issues.

See also milestones to see what is currently planned.

Back to top

Project Help

If you want to say "thank you" and/or support active development of MidOS:

• Add a GitHub Star to the project's GitHub awareness page. (our project is not mirrored to prevent GitHub Copilot)
• Tweet about MidOS or spread the word on other social media.
• Write interesting articles about the project on Dev.to, Medium, or your personal blog.
• Help fund our contributors on:
  • Liberapay
  • Buy me a coffee
  • Ko-Fi

Together, we can make MidOS better!

Back to top

Contributing

Firstly, thanks for considering to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Back to top

Acknowledgements

Sponsors, Donations, and Patrons

Special thanks to these sponsors for donating servers and other compute:

• Griddy

All patrons can be found at:

• Liberapay
• Buy me a coffee
• Ko-Fi

Back to top

Software Used

• The Amazing Github Template for the README.md and some other documents.
• The create-project tool for this template repository.
• NixOS
• Nix Flakes

Back to top

Inspirations

This project takes some inspiration from various, miscellaneous linux distros which attempt at having sane defaults.

Some projects we have drawn inspiration from in particular are:

• Snowfall
• Spectrum OS
• home-manager
• wrapper-manager

Back to top

Authors & Contributors

The original setup of this repository is by midirhee12.

For a full list of all authors and contributors, see the contributors page.

Back to top

Security

MidOS follows good practices of security, but 100% security cannot be assured. MidOS is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

Back to top

License

Copyright (C) 2024 midirhee12

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/

Back to top