Merge branch 'main' of https://github.com/MarkPavlenko/PyTermOS

Author: markpavlenko

CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to PyTermOS
+Thank you for your interest in contributing to PyTermOS! We welcome contributions from anyone and are grateful for every bit of assistance.
+
+This document provides guidelines for contributing to PyTermOS. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
+
+Getting Started
+Fork the Repository: Start by forking the PyTermOS repository on GitHub.
+Clone Your Fork: Clone your fork to your local machine so you can do your work.
+```bash
+git clone https://github.com/MarkPavlenko/PyTermOS.git
+cd PyTermOS 
+```
+Create a New Branch: For each new feature or bug fix, create a new branch based on the main branch.
+```bash
+git checkout -b feature-branch-name
+```
+# Making Changes
+## Make Your Changes
+Add or change the code as necessary for your new feature or bug fix.
+## Follow the Code Style
+Ensure your code conforms to the existing style of the project to maintain consistency.
+## Write Meaningful Commit Messages
+Your commit messages should explain why and what your changes do.
+# Testing
+Test Your Changes: Before submitting your changes, make sure your changes do not break the existing functionality. Run any existing tests and add new ones if necessary.
+# Submitting Changes
+Push Your Changes: Push your changes to your fork on GitHub.
+
+```bash
+git push origin feature-branch-name
+```
+## Submit a Pull Request
+Go to your fork on GitHub and click the "New pull request" button. Make sure you are requesting to pull from your branch to the main branch of the PyTermOS repository.
+# Code Review
+## Respond to Feedback
+If the maintainers have feedback or questions about your changes, please respond promptly and make any required updates.
+## Accept Criticism Gracefully
+Remember that the criticism from a review is about the code and not about you as a person.
+# Stay Involved
+Contributions go beyond pull requests and commits. You can really help by:
+
+### Reporting bugs.
+### Suggesting new features.
+### Writing or improving documentation.
+### Helping others in the community.
+
+### Thank you for your contributions!

README.md

@@ -1 +1,47 @@
+# PyTermOS
+![image](https://github.com/MarkPavlenko/PyTermOS/assets/109904787/c3d32466-7f25-453b-81bb-b19caedba08b)
 
+PyTermOS is a lightweight, Linux-Based operating system designed specifically for educational purposes and older hardware, emphasizing minimalism and efficiency. It provides lot's of great everyday functions like Supercommands and other. Here, at PyTermOS you can see the power of Linux-Based operating systems.
+# Features
+## Lightweight Design
+
+Optimized for performance on both modern and legacy hardware (Raspberry Pi Family).
+## Educational Tool
+Perfect for students and enthusiasts looking to delve into the workings of a Linux-based OS.
+## PyTerm CLI Interface.
+PyTerm CLI Interface is very easy to use. Especially for people who think bash is hard to learn.
+To see the commands, you can type ? or help in the PyTerm CLI Interface.
+To see the usage of the commands, please go to [PyTerm's official README file](https://github.com/MarkPavlenko/PyTerm/blob/main/README.md).
+## Community Driven
+Open to contributions and improvements. You can fork or download the .zip file to make changes.
+# Installation
+The installation is very easy and great for people the only start using Linux Distros.
+## Requirements
+A Raspberry Pi (Works on every version of RPi),
+
+SD Card (minimum 8 GB recommended)
+and
+
+Internet connection for initial setup and downloads.
+## Installation Guide
+Download the latest release of PyTermOS from the Releases page.
+### Write the image to an SD card
+Use a tool like RPi-Imager or Balena Etcher. 
+Insert the SD card into your Raspberry Pi.
+### Boot your Raspberry Pi
+Connect your Raspberry Pi to power and a display.
+Wait until the system starts.
+# Usage
+After installing PyTermOS, you can interact with the system through the [PyTerm](markpavlenko.github.io/PyTerm) command line interface (PTCLI).
+## Starting the CLI
+Turn on your Raspberry Pi.
+Wait until the system starts.
+When the loading ends, you will be greeted by the [PyTerm](markpavlenko.github.io/PyTerm) command prompt.
+# Contributing
+We welcome contributions from the community! Whether it's bug fixes, feature additions, or improvements to documentation, your help is appreciated. Please read CONTRIBUTING.md for details on the process for submitting pull requests to me.
+# License
+PyTermOS is open source and freely available under the MIT License. See the LICENSE file for more details.
+# Releases page
+To see all the releases, please go to this [https://github.com/MarkPavlenko/PyTermOS/releases](https://github.com/MarkPavlenko/PyTermOS/releases) page.
+## Contact
+For support, feedback, or queries, please reach me out at markpavlenkos@icloud.com (main) or at markpavlenkos@gmail.com (trash).