Skip to content

doc: update README #1127

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 12, 2024
Merged

doc: update README #1127

merged 1 commit into from
Apr 12, 2024

Conversation

phip1611
Copy link
Member

Clean up of the README and better separation of user documentation and developer documentation.

Checklist

  • Sensible git history (for example, squash "typo" or "fix" commits). See the Rewriting History guide for help.
  • Update the changelog (if necessary)

nicholasbishop
nicholasbishop approved these changes Apr 11, 2024
View reviewed changes
Copy link
Member

@nicholasbishop nicholasbishop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I think this is a much clearer organization

@phip1611
doc: cleanup & update README
4035cfa 
- Better separation of developer documentation and user documentation
- More appealing introduction
@phip1611 phip1611 enabled auto-merge April 12, 2024 10:50
@phip1611 phip1611 added this pull request to the merge queue Apr 12, 2024
Merged via the queue into rust-osdev:main with commit 92ba86e Apr 12, 2024
@phip1611 phip1611 deleted the doc2 branch April 12, 2024 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicholasbishop nicholasbishop nicholasbishop approved these changes

@GabrielMajeri GabrielMajeri Awaiting requested review from GabrielMajeri

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@phip1611 @nicholasbishop