Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a better README description #57

Closed
Kfeavel opened this issue Jun 30, 2020 · 3 comments
Closed

Create a better README description #57

Kfeavel opened this issue Jun 30, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation feature Additional functionality

Comments

@Kfeavel
Copy link
Member

Kfeavel commented Jun 30, 2020

Draft:

Panix

Panix is a small, hobbyist kernel started by Keeton Feavel and further developed with the help of Micah Switzer.
Having now undergone three rewrites from the ground up, Panix has come a long way since its first start in 2018.

Design Philosophy

Panix is designed to be readable first and foremost. Having been developed at Cedarville University, the primary goal of Panix is to provide an opportunity for students (and anyone else interested) to learn the intricacies of kernel development. Function names are descriptive and structs are used when possible in order to help increase the legibility of code and provide an "easy-in" for kernel development.

Accomplishments

Panix is the subject of an independent study and the associated final report published by Keeton Feavel at Cedarville and used by Patrick Dudenhofer to help instruct students of CS-3320 (Operating Systems). The cedarville branch is an older, modified version of the Panix kernel used as a template for assignments designed to help concepts such as CPU ports and hardware communication. Eventually, once paging is fully implemented, another assignment will be developed to help explain paging and memory management.

How to Help

We are constantly looking for people to help contribute to Panix. If you would like to contribute driver code or a new feature, feel free to fork the repository and submit a pull request. If you are a student who would like to get involved, feel free to contact any of the project contributors.

@Kfeavel Kfeavel added the documentation Improvements or additions to documentation label Jun 30, 2020
@Kfeavel Kfeavel self-assigned this Jun 30, 2020
@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label feature_request to this issue, with a confidence of 0.94. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@issue-label-bot issue-label-bot bot added the feature Additional functionality label Jun 30, 2020
@micahswitzer
Copy link
Member

Could you create a PR with that change and we could go from there?

@Kfeavel
Copy link
Member Author

Kfeavel commented Jul 3, 2020

Pull request #62 has been created.

@Kfeavel Kfeavel closed this as completed Jul 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature Additional functionality
Projects
None yet
Development

No branches or pull requests

2 participants