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.

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

Slightly rework README for clarity #1878

Closed
cwgoes opened this issue Mar 5, 2023 · 0 comments · Fixed by #1904
Closed

Slightly rework README for clarity #1878

cwgoes opened this issue Mar 5, 2023 · 0 comments · Fixed by #1904
Assignees
@jonaprieto
Labels
enhancement New feature or request

Comments

@cwgoes
Copy link
Contributor

cwgoes commented Mar 5, 2023 •
edited
Loading

Is your feature request related to a problem? Please describe.

The Juvix repository is often going to be the first place developers go to learn about the project, and I think they might not yet walk away (from reading the README) with a clear understanding of what Juvix is and how it relates to other parts of the Anoma compiler stack and execution environment.

Describe the solution you'd like

I suggest that the README start with the general description - "Juvix is a high-level programming language for writing privacy-preserving decentralised applications." - then explain briefly how Juvix relates to VampIR (compiles to it) and Taiga (programs can be deployed to it) - perhaps a diagram would be helpful here. The rest of the README (the language features part, and the Community part) is already great 😄.

Describe alternatives you've considered
N/A

Additional context
N/A
@cwgoes cwgoes added enhancement New feature or request pending-review labels Mar 5, 2023
@jonaprieto jonaprieto self-assigned this Mar 6, 2023
@jonaprieto jonaprieto mentioned this issue Mar 20, 2023
Merged
jonaprieto added a commit that referenced this issue Mar 21, 2023
@jonaprieto @paulcadman
@cwgoes @janmasrovira
Add new README and md files (#1904)
22ba8f1 
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.🤞

- Closes #1878
- New pre-commit hook to format md, yaml, js, CSS files.

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

- https://jonaprieto.github.io/juvix
- https://github.com/jonaprieto/juvix

---------

Co-authored-by: Paul Cadman <[email protected]>
Co-authored-by: Christopher Goes <[email protected]>
Co-authored-by: Jan Mas Rovira <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jonaprieto jonaprieto

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add new README and md files
2 participants
@jonaprieto @cwgoes