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

readme: rewrite from org to markdown #10

Merged
merged 1 commit into from
Aug 27, 2022

Conversation

soupglasses
Copy link
Contributor

Change reason: Markdown is a more common markup language compared to
emacs org mode. This will let more people be able to contribute back
into the documentation effort of nix-minecraft.

Also most editors do not have support for org-mode either, which further
complicates using it as a standard for the README of the project.

@soupglasses
Copy link
Contributor Author

This is also meant to be a first step to help the rewriting process of the README. Hopefully documenting all TODO sections, as well as building up the examples here inside the repo to help #6

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Change reason: Markdown is a more common markup language compared to
emacs org mode. This will let more people be able to contribute back
into the documentation effort of `nix-minecraft`.
Copy link
Owner

@Infinidoge Infinidoge left a comment

Choose a reason for hiding this comment

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

Looks good to me, merging!

@Infinidoge Infinidoge merged commit dfe3d95 into Infinidoge:master Aug 27, 2022
@soupglasses soupglasses deleted the pr/readme branch August 27, 2022 17:24
soupglasses pushed a commit to soupglasses/nix-minecraft that referenced this pull request Aug 27, 2022
readme: rewrite from org to markdown
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants