Skip to content
This repository was archived by the owner on May 5, 2024. It is now read-only.

Commit efcb4e4

Browse files
authored
Update README.md
1 parent f47b0f6 commit efcb4e4

File tree

1 file changed

+69
-7
lines changed

1 file changed

+69
-7
lines changed

README.md

Lines changed: 69 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,75 @@
1-
# welcome to PythonicOS
1+
# PythonicOS
22

3-
built ontop of a custom ISO version of TinyCore Linux, PythonicOS is made for the pythoners that want to play around with python in a vm or a actual machine, it includes pip, pyQT and the respective packages.
3+
PythonicOS is an open-source operating system built on top of the Linux kernel and the GRUB bootloader. It is developed using a combination of Python and C programming languages, making it an ideal choice for developers familiar with these languages.
44

5-
there are 2 versions of this Operating system.
5+
## Features
66

7-
one built in Tkinter for compatibility with older software.
7+
- **Pythonic Environment:** PythonicOS provides a familiar environment for Python developers, allowing them to leverage their existing knowledge and libraries to build applications and system components.
88

9-
and one built in PyQT for later software.
9+
- **Linux Kernel:** Built on top of the reliable and robust Linux kernel, PythonicOS inherits its stability, security, and hardware compatibility features.
1010

11-
its best to use the Tkinter one as its easy to use and better overall for development!
11+
- **GRUB Bootloader:** PythonicOS utilizes the GRUB (GRand Unified Bootloader) to handle the boot process, providing flexibility and support for various hardware configurations.
1212

13-
thanks ofr taking the time to read this garbage intro readme!
13+
- **Extensibility:** PythonicOS is designed with extensibility in mind. Developers can easily extend and customize the operating system by writing modules and adding new features.
14+
15+
## Getting Started
16+
17+
### Prerequisites
18+
19+
To build and run PythonicOS, you will need the following software installed on your system:
20+
21+
- Linux kernel source code
22+
- GRUB bootloader
23+
- Python 3.x or later
24+
- requirements from the requirements.txt file, you can install them using Pip install -R requirements.txt
25+
26+
### Building PythonicOS
27+
28+
1. Clone the PythonicOS repository:
29+
30+
git clone https://github.com/OpenStudioCorp/PythonicOS.git
31+
32+
2. Change into the PythonicOS directory:
33+
34+
3. cd PythonicOS
35+
36+
Build the operating system using the provided build script:
37+
38+
#Running PythonicOS
39+
40+
Install the GRUB bootloader on a bootable device (e.g., USB drive) using the following command:
41+
42+
grub-install /dev/sdX
43+
44+
Replace /dev/sdX with the appropriate device identifier for your system.
45+
46+
Copy the generated kernel image and configuration files to the bootable device.
47+
48+
Reboot your system and select the bootable device as the boot source in your BIOS or UEFI settings.
49+
----------------------------------------------------------------------------------------------------
50+
51+
# Contributing
52+
53+
We welcome contributions from the community to enhance PythonicOS. To contribute, please follow these steps:
54+
55+
Fork the PythonicOS repository.
56+
57+
Create a new branch for your feature or bug fix:
58+
59+
git checkout -b feature/your-feature-name
60+
61+
Make the necessary changes and commit them:
62+
63+
git commit -m "Add your commit message here"
64+
65+
Push your changes to your forked repository:
66+
67+
git push origin feature/your-feature-name
68+
69+
Open a pull request in the original PythonicOS repository, describing your changes and their purpose.
70+
------------------------------------------------------------------------------------------------------
71+
License
72+
PythonicOS is released under the MIT License.
73+
74+
Contact
75+
For any questions, suggestions, or feedback, please reach out to us at your-email@example.com.

0 commit comments

Comments
 (0)