mirror of
https://github.com/wren-lang/wren.git
synced 2026-01-11 22:28:45 +01:00
Move the community docs to the wiki.
This commit is contained in:
@ -209,8 +209,8 @@ receiver:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
Code like this gets tricky when you there is also a variable outside of the
|
Code like this gets tricky when there is also a variable outside of the class
|
||||||
class with the same name. Consider:
|
with the same name. Consider:
|
||||||
|
|
||||||
:::wren
|
:::wren
|
||||||
var name = "variable"
|
var name = "variable"
|
||||||
|
|||||||
@ -1,48 +0,0 @@
|
|||||||
^title Community
|
|
||||||
|
|
||||||
Like the [bird](https://en.wikipedia.org/wiki/Wren), Wren's community is small,
|
|
||||||
but it exists!
|
|
||||||
|
|
||||||
## User group
|
|
||||||
|
|
||||||
There's one Wren user group, and it's the [official Wren mailing
|
|
||||||
list](https://groups.google.com/forum/#!forum/wren-lang). Please join it and
|
|
||||||
say hello! There are no strangers to Wren, just friends we haven't met yet.
|
|
||||||
|
|
||||||
## Libraries
|
|
||||||
|
|
||||||
There are some third-party libraries that are written in Wren. Here's the list:
|
|
||||||
|
|
||||||
- [Please](https://github.com/EvanHahn/wren-please): An assertion library.
|
|
||||||
- [wren-colors](https://github.com/gsmaverick/wren-colors): Print colored
|
|
||||||
messages to the terminal.
|
|
||||||
- [wren-test](https://github.com/gsmaverick/wren-test): A testing framework.
|
|
||||||
- [wren-vector3d](https://github.com/EvanHahn/wren-vector3d): 3D vectors.
|
|
||||||
|
|
||||||
## Language bindings
|
|
||||||
|
|
||||||
Want to host a Wren VM within another language. Try these:
|
|
||||||
|
|
||||||
- [JavaScript: ppvk/wrenjs](https://github.com/ppvk/wrenjs)
|
|
||||||
- [Rust: tilpner/wren-sys](https://github.com/tilpner/wren-sys)
|
|
||||||
- [Rust: pwoolcoc/wren-sys](https://github.com/pwoolcoc/wren-sys)
|
|
||||||
- [Rust: pwoolcoc/wren-rs](https://github.com/pwoolcoc/wren-rs)
|
|
||||||
|
|
||||||
## Editor integrations
|
|
||||||
|
|
||||||
If you want Wren syntax highlighting in your editor, look no further:
|
|
||||||
|
|
||||||
- [Emacs](https://github.com/v2e4lisp/wren-mode.el)
|
|
||||||
- [Sublime Text](https://github.com/munificent/wren-sublime)
|
|
||||||
- [Vim](https://github.com/lluchs/vim-wren)
|
|
||||||
|
|
||||||
## Tools and Utilities
|
|
||||||
|
|
||||||
Things that make life easier:
|
|
||||||
|
|
||||||
- [The Wren Nest](http://ppvk.github.io/wren-nest/): Run and share Wren in your
|
|
||||||
browser.
|
|
||||||
|
|
||||||
Do you have anything to add here? Send a [pull request][]!
|
|
||||||
|
|
||||||
[pull request]: https://github.com/munificent/wren/pulls
|
|
||||||
@ -1,40 +1,52 @@
|
|||||||
^title Contributing
|
^title Contributing
|
||||||
|
|
||||||
Wren is under active development and there's lots to do. We'd be delighted to
|
Like the bird, Wren's ecosystem is small but full of life. Almost everything is
|
||||||
have you help!
|
under active development and there's lots to do. We'd be delighted to have you
|
||||||
|
help.
|
||||||
|
|
||||||
## Getting acquainted
|
The first thing to do is to join [the official mailing list][list] and say,
|
||||||
|
"Hi". There are no strangers to Wren, just friends we haven't met yet.
|
||||||
|
|
||||||
[Pull requests][pull request] and [bug reports][issue] are always welcome. But,
|
## Growing the ecosystem
|
||||||
if you'd like to dip your toes in the water before diving in, please join
|
|
||||||
[the mailing list][list] and say, "Hi". There's no strangers to Wren, just
|
|
||||||
friends we haven't met yet.
|
|
||||||
|
|
||||||
## The source
|
The simplest and often most helpful way to join the Wren party is to be a Wren
|
||||||
|
*user*. Create an application that embeds Wren. Write a library or a handy
|
||||||
|
utility in Wren. Add syntax highlighting support for Wren to your favorite text
|
||||||
|
editor. Share that stuff and it will help the next Wren user to come along.
|
||||||
|
|
||||||
Wren uses the OSI-approved [MIT license][mit]. I'm not sure exactly what that
|
If you do any of the above, let us know by adding it to the wiki. We like to
|
||||||
means, but I went with the most permissive license I could find.
|
keep track of:
|
||||||
|
|
||||||
The source is developed [on GitHub][github]. My hope is that the codebase,
|
* [Applications][] that host Wren as a scripting language.
|
||||||
tests, and [documentation][docs] are easy to understand and contribute to. If
|
* [Modules][] written in Wren that others can use.
|
||||||
they aren't, that's a bug.
|
* [Language bindings][] that let you interact with Wren from other programming
|
||||||
|
languages.
|
||||||
|
* Other [tools and utilities][] that make it easier to be a Wren programmer.
|
||||||
|
|
||||||
## Finding something to hack on
|
[applications]: https://github.com/munificent/wren/wiki/Applications
|
||||||
|
[modules]: https://github.com/munificent/wren/wiki/Modules
|
||||||
|
[language bindings]: https://github.com/munificent/wren/wiki/Language-Bindings
|
||||||
|
[tools and utilities]: https://github.com/munificent/wren/wiki/Tools
|
||||||
|
|
||||||
Eventually, the [issue tracker][issue] will be populated with a more complete
|
## Contributing to Wren
|
||||||
set of changes and features I have in mind. Until then, one easy way to find
|
|
||||||
things that need doing is to look for `TODO` comments in the code.
|
|
||||||
|
|
||||||
Also, writing code in Wren and seeing what problems you run into is incredibly
|
You're also more than welcome to contribute to Wren itself, both the core VM and
|
||||||
helpful. Embedding Wren in an application will also exercise lots of corners of
|
the command-line interpreter. The source is developed [on GitHub][github]. Our
|
||||||
the system and highlight problems and missing features.
|
hope is that the codebase, tests, and [documentation][docs] are easy to
|
||||||
|
understand and contribute to. If they aren't, that's a bug.
|
||||||
|
|
||||||
Of course, new ideas are also welcome as well! If you have an idea for a
|
### Finding something to hack on
|
||||||
significant change or addition, please file a [proposal][] to discuss it
|
|
||||||
before writing lots of code. Wren tries very *very* hard to be minimal which
|
Between the [issue tracker][issue] and searching for `TODO` comments in the
|
||||||
|
code, it's pretty easy to find something that needs doing, though we don't
|
||||||
|
always do a good job of writing everything down.
|
||||||
|
|
||||||
|
If nothing there suits your fancy, new ideas are welcome as well! If you have an
|
||||||
|
idea for a significant change or addition, please file a [proposal][] to discuss
|
||||||
|
it before writing lots of code. Wren tries very *very* hard to be minimal which
|
||||||
means often having to say "no" to language additions, even really cool ones.
|
means often having to say "no" to language additions, even really cool ones.
|
||||||
|
|
||||||
## Hacking on docs
|
### Hacking on docs
|
||||||
|
|
||||||
The [documentation][] is one of the easiest—and most
|
The [documentation][] is one of the easiest—and most
|
||||||
important!—parts of Wren to contribute to. The source for the site is
|
important!—parts of Wren to contribute to. The source for the site is
|
||||||
@ -74,7 +86,7 @@ docs when you edit a file:
|
|||||||
:::sh
|
:::sh
|
||||||
$ make watchdocs
|
$ make watchdocs
|
||||||
|
|
||||||
## Hacking on the VM
|
### Hacking on the VM
|
||||||
|
|
||||||
The basic process is simple:
|
The basic process is simple:
|
||||||
|
|
||||||
@ -108,9 +120,11 @@ The basic process is simple:
|
|||||||
fun open source project! I'll take it from here and hopefully we'll get it
|
fun open source project! I'll take it from here and hopefully we'll get it
|
||||||
landed smoothly.
|
landed smoothly.
|
||||||
|
|
||||||
|
## Getting help
|
||||||
|
|
||||||
If at any point you have questions, feel free to [file an issue][issue] or ask
|
If at any point you have questions, feel free to [file an issue][issue] or ask
|
||||||
on the [mailing list][list]. You can also email me directly (`robert` at
|
on the [mailing list][list]. You can also email me directly (`robert` at
|
||||||
`stuffwithstuff.com`) if you want something less public. *Thank you!*
|
`stuffwithstuff.com`) if you want something less public.
|
||||||
|
|
||||||
[mit]: http://opensource.org/licenses/MIT
|
[mit]: http://opensource.org/licenses/MIT
|
||||||
[github]: https://github.com/munificent/wren
|
[github]: https://github.com/munificent/wren
|
||||||
|
|||||||
@ -23,7 +23,6 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><a href="getting-started.html">Getting Started</a></li>
|
<li><a href="getting-started.html">Getting Started</a></li>
|
||||||
<li><a href="contributing.html">Contributing</a></li>
|
<li><a href="contributing.html">Contributing</a></li>
|
||||||
<li><a href="community.html">Community</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<section>
|
<section>
|
||||||
<h2>language guide</h2>
|
<h2>language guide</h2>
|
||||||
@ -57,7 +56,6 @@
|
|||||||
<tr>
|
<tr>
|
||||||
<td><a href="getting-started.html">Getting Started</a></td>
|
<td><a href="getting-started.html">Getting Started</a></td>
|
||||||
<td><a href="contributing.html">Contributing</a></td>
|
<td><a href="contributing.html">Contributing</a></td>
|
||||||
<td><a href="community.html">Community</a></td>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2"><h2>language guide</h2></td>
|
<td colspan="2"><h2>language guide</h2></td>
|
||||||
|
|||||||
Reference in New Issue
Block a user