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

Add new README and md files #1904

Merged
merged 20 commits into from
Mar 21, 2023
Merged

Add new README and md files #1904

merged 20 commits into from
Mar 21, 2023

Conversation

jonaprieto
Copy link
Collaborator

@jonaprieto jonaprieto commented Mar 20, 2023

In this PR, I have updated the README file to reflect the new goals of the project and highlight related products to Juvix. The ORG files have been replaced with Markdown for better readability and maintainability. Additionally, I have added a couple of files to fine-tune the mdbook settings. These changes, I believe, will make it easier for users to understand and contribute to the project.🤞

To check the website generation, I have deployed the result here:
Work in progress.

@jonaprieto jonaprieto self-assigned this Mar 20, 2023
@jonaprieto jonaprieto added the enhancement New feature or request label Mar 20, 2023
@jonaprieto jonaprieto added this to the 0.3.1 milestone Mar 20, 2023
@jonaprieto jonaprieto requested review from paulcadman and cwgoes March 20, 2023 14:40
@janmasrovira janmasrovira self-requested a review March 21, 2023 09:10
@jonaprieto jonaprieto marked this pull request as ready for review March 21, 2023 09:16
Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

Looks wonderful! I made a minor suggestion to the README just to clarify the backends in the first paragraph.

@jonaprieto jonaprieto requested a review from janmasrovira March 21, 2023 12:05
@jonaprieto jonaprieto requested a review from paulcadman March 21, 2023 16:00
@jonaprieto jonaprieto merged commit 22ba8f1 into anoma:main Mar 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Slightly rework README for clarity
4 participants