diff --git a/README.md b/README.md index d4e9d16..a6a4292 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,69 @@ # Pop!\_OS -Pop!\_OS is designed for people who use their computer to create; whether it’s complicated, professional grade software and products, sophisticated 3D models, computer science in academia, or makers working on their latest invention. The Pop! user interface stays out of the way while offering extensive customization to perfect your work flow. Built on Ubuntu, you have access to vast repositories of open source software and development tools. +**Pop!\_OS** is a Linux distribution designed for creators—whether you're building professional software, crafting 3D models, diving into computer science, or working on innovative projects. The interface is sleek and unobtrusive, offering extensive customization options to optimize your workflow. -Pop!\_OS’s first release was on October 19th, 2017. For more information, [visit the Pop!\_OS website](https://system76.com/pop) and [view the Pop!\_OS documentation](https://support.system76.com/). +Built on Ubuntu, Pop!\_OS opens the door to a vast repository of open-source software and development tools. + +- **First Release**: October 19, 2017 +- [Official Website](https://system76.com/pop) +- [Pop!\_OS Documentation](https://support.system76.com/) + +--- ## Purpose -The purpose of this repository is to allow easy management of all Pop!\_OS related source code and assets. To view a list of all included repositories, see [REPOS.md](./REPOS.md). +This repository is designed to facilitate the management of Pop!\_OS-related source code and assets. + +To explore the list of all included repositories, refer to [REPOS.md](./REPOS.md). -Binary packages are hosted [in the Pop!_OS APT repositories](https://apt.pop-os.org/). Many packages have source on GitHub under the [Pop!\_OS organization](https://github.com/pop-os). Some related components or documentation may be hosted under the [System76 organization](https://github.com/system76). +- **Binary Packages**: Hosted in the [Pop!\_OS APT repositories](https://apt.pop-os.org/). +- **Source Code**: Available on GitHub under the [Pop!\_OS organization](https://github.com/pop-os). + - Additional components and documentation are found under the [System76 organization](https://github.com/system76). + +--- ## Developer Resources -For instructions on how to build the shell: +### Building the Shell + +To build the Pop!\_OS shell, check out the following guides: + +- [COSMIC (GNOME-based)](https://github.com/pop-os/cosmic) +- [COSMIC Epoch (Rust-based)](https://github.com/pop-os/cosmic-epoch) -* [COSMIC (GNOME-based)](https://github.com/pop-os/cosmic) -* [COSMIC Epoch (Rust-based)](https://github.com/pop-os/cosmic-epoch) - -Developer chat: https://chat.pop-os.org/pop-os/channels/development +### Developer Communication -### Contributing to Pop!_OS +Join the conversation on the [Pop!\_OS Development Chat](https://chat.pop-os.org/pop-os/channels/development). -For instructions and guidelines to make changes in Pop!_OS, see [CONTRIBUTING.md](./CONTRIBUTING.md). +--- + +## Contributing + +To contribute to Pop!\_OS, follow the guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md). + +--- ## Dependencies -You must install the following packages to use this repository: +Before using this repository, install the following package: - `python3-launchpadlib` -## Scripts +--- + +## Available Scripts + +The repository includes several helpful scripts for managing Pop!\_OS: + +- **`scripts/clone`** - Clone source code repositories. +- **`scripts/debversion`** - Display the version of a Debian package. +- **`scripts/ignore`** - Generate a `.gitignore` file. +- **`scripts/issues`** - List open issues. +- **`scripts/launchpad`** - Display available PPA packages. +- **`scripts/prs`** - View pull requests. +- **`scripts/pull`** - Update source code repositories. +- **`scripts/readme`** - Generate the `REPOS.md` file. +- **`scripts/validate`** - Validate the presence of key documentation files (e.g., `LICENSE`, `README`, and `TESTING`). -This repository contains the following commands: +--- -- `scripts/clone` - clone source code -- `scripts/debversion` - show version of debian package -- `scripts/ignore` - generate `.gitignore` -- `scripts/issues` - show issues -- `scripts/launchpad` - show PPA packages -- `scripts/prs` - show pull requests -- `scripts/pull` - update source code -- `scripts/readme` - generate `REPOS.md` -- `scripts/validate` - validate Pop!\_OS source code for presence of `LICENSE`, `README`, and `TESTING` documentation