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 the initial README.md #1

Merged
merged 2 commits into from
May 1, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# Mojo
The Mojo Programming Language
# Welcome to Mojo

Mojo is a new programming language that bridges the gap between research
and production by combining Python syntax and ecosystem with systems
programming and metaprogramming features. Mojo is still early, but it is designed
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
programming and metaprogramming features. Mojo is still early, but it is designed
programming and metaprogramming features. Mojo is still young, but it is designed

to become a superset of
Python over time. This will allow Python's dynamic features to continue
Copy link
Collaborator

Choose a reason for hiding this comment

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

This last sentence is a little superfluous and I think you can cut it for brevity. I'd leave it to the other docs (such as "Why Mojo") to elaborate on the Python story.

to shine but also unleash Python from the shackles of C and C++ under the hood.

We expect Mojo to be open-sourced progressively over time, but for now it's still
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
We expect Mojo to be open-sourced progressively over time, but for now it's still
We plan to open-source Mojo progressively over time, but for now it's still

young and changing very quickly. We believe that a small,tight-knit group of
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
young and changing very quickly. We believe that a small,tight-knit group of
young and changing very quickly. We believe that a small, tight-knit group of

engineers with a shared vision can move faster than a community effort, so we will
continue to incubate it within Modular until it's more complete. Please see the
[Mojo FAQ](https://docs.modular.com/mojo/faq.html) for answers to this and other
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
[Mojo FAQ](https://docs.modular.com/mojo/faq.html) for answers to this and other
[Mojo FAQ](https://docs.modular.com/mojo/faq.html) for more about this and answers to other

common questions.

We've opened this repo now because we want to gather issues and engage in feedback
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
We've opened this repo now because we want to gather issues and engage in feedback
We've opened this repo now because we want to receive issue reports and collect feedback

from users who have access to the Mojo Playground (our hosted JupyterHub
where you can try coding with an early version of Mojo). To get access to the
Mojo Playground, [see here to sign up](https://docs.modular.com/mojo/get-started.html).
Then, when you want to report issues or request features,
[please create a GitHub issue here](https://github.com/modularml/mojo/issues).

For more general questions or to chat with other Mojo developers,
check out our [Discord](https://discord.gg/modular)

Otherwise, you can:
- Read the [inspiration behind Mojo](https://docs.modular.com/mojo/why-mojo.html).
- Check out the [Mojo programming manual](https://docs.modular.com/mojo/programming-manual.html).
- Many other docs on [docs.modular.com](https://docs.modular.com).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- Many other docs on [docs.modular.com](https://docs.modular.com).
- Read more docs at [docs.modular.com/mojo](https://docs.modular.com/mojo).