mirror of
https://github.com/RustPython/RustPython.git
synced 2026-10-28 18:59:04 +08:00
README Update
This commit is contained in:
1 parent
724d9c6dcb
commit
2ad4dddd16
1 file changed
+13
-2
@@ -3,6 +3,7 @@
|
||||
A Python-3 (CPython >= 3.5.0) Interpreter written in Rust :snake: :scream: :metal:.
|
||||
|
||||
[](https://travis-ci.org/RustPython/RustPython)
|
||||
[](https://dev.azure.com/ryan0463/ryan/_build/latest?definitionId=1&branchName=master)
|
||||
[](https://codecov.io/gh/RustPython/RustPython)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://github.com/RustPython/RustPython/graphs/contributors)
|
||||
@@ -26,6 +27,14 @@ Or use the interactive shell:
|
||||
>>>>> 2+2
|
||||
4
|
||||
|
||||
# Disclaimer
|
||||
|
||||
RustPython is in a development phase and should not used in production or a fault intolerant setting.
|
||||
|
||||
Our current build supports only a subset of Python syntax.
|
||||
|
||||
Contribution is also more than welcome! See our contribution section for more information on this.
|
||||
|
||||
# Goals
|
||||
|
||||
- Full Python-3 environment entirely in Rust (not CPython bindings)
|
||||
@@ -33,7 +42,7 @@ Or use the interactive shell:
|
||||
|
||||
# Documentation
|
||||
|
||||
Currently the project is in an early phase, and so is the documentation.
|
||||
Currently along with other areas of the project, documentation is still in an early phase.
|
||||
|
||||
You can read the [online documentation](https://rustpython.github.io/website/rustpython/index.html) for the latest code on master.
|
||||
|
||||
@@ -63,7 +72,9 @@ If you wish to update the online documentation. Push directly to the `release` b
|
||||
|
||||
# Contributing
|
||||
|
||||
To start contributing, there are a lot of things that need to be done.
|
||||
Contributions are more than welcome, and in many cases we are happy to guide contributors through PRs or on gitter.
|
||||
|
||||
With that in mind, please note this project is maintained by voulenteers, some of the best ways to get started are below:
|
||||
|
||||
Most tasks are listed in the [issue tracker](https://github.com/RustPython/RustPython/issues).
|
||||
Check issues labeled with `good first issue` if you wish to start coding.
|
||||
|
||||
Reference in new issue
Block a user