aviumcaravan
/
prism-linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

main
Riley Ambers 2022-09-19 12:49:24 +00:00
parent f46ab6e716
commit 0677eeb3a9
1 changed files with 18 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
README.md
View File

@ -2,91 +2,38 @@
Prism Linux - a homebrew LLVM+musl, suckless, Hummingbird and pkgsrc-based Linux distribution loosely based on Linux From Scratch.
## Getting started
## Why choose Prism?
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Honestly, choose it if you're used to systems like KISS or NetBSD. Other than that, just try to avoid it. It's strongly experimental.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## What are the licencing terms?
## Add your files
Well, it depends. Mainly GPLv2/v3 or BSD-style. The vast majority of the system is designed for dodging the GNU userspace with a few exceptions, every source package will be available in the repo so you can figure it out.
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
## What is the application of this distro?
```
cd existing_repo
git remote add origin https://git.sakamoto.pl/aviumcaravan/prism-linux.git
git branch -M main
git push -uf origin main
```
Personal use or development. The bootstrap image is just supposed to feature a toolchain, package manager, init system and basic userspace tools. A bunch of binary packages will be hosted on the online repository, but things like an X11 environment will have to be built on your end using pkgsrc.
## Integrate with your tools
## Will there be support for architectures other than AMD64?
- [ ] [Set up project integrations](https://git.sakamoto.pl/aviumcaravan/prism-linux/-/settings/integrations)
I do have it in mind and I'm open to contributions, but as for now the answer is "no".
## Collaborate with your team
## What package managers does the system feature?
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
There's the POSIX sh-based custom `pkgmgr` (basically just a set of scripts to update the base system) and then there's `pkgsrc` (source) with `pkgin` (binary).
## Test and Deploy
## What release model is planned?
Use the built-in continuous integration in GitLab.
All things considered, the most optimal update model for me would be once every 3 months, which would line up with the pkgsrc snapshot updates.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
## Where can I find the documentation for the system?
***
Most answers you can find in manpages of the packages or the pkgsrc wiki pages, and there's a plan of creating a documentation page for the `pkgmgr` package system on the repository tree.
# Editing this README
## Any personal notes?
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
Yes! Please try to avoid using GNU utilites as much as possible, use filesystems like btrfs, JFS or HFS+ (to replicate my experiences) and use LTS kernels.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Can you provide us with binary kernel images?
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
Possibly in the future, but as for now I'd prefer to have people building their own images simply because of how god damn heavy my personal config is, heh...