From ffb5ada9fbad9199dab3c996af03b4f2ae3861cc Mon Sep 17 00:00:00 2001 From: Bob Nystrom Date: Sun, 24 Jan 2016 15:39:35 -0800 Subject: [PATCH] Move the community docs to the wiki. --- doc/site/classes.markdown | 4 +-- doc/site/community.markdown | 48 ------------------------- doc/site/contributing.markdown | 66 ++++++++++++++++++++-------------- doc/site/template.html | 2 -- 4 files changed, 42 insertions(+), 78 deletions(-) delete mode 100644 doc/site/community.markdown diff --git a/doc/site/classes.markdown b/doc/site/classes.markdown index 89f0d06f..bca2e39a 100644 --- a/doc/site/classes.markdown +++ b/doc/site/classes.markdown @@ -209,8 +209,8 @@ receiver: } } -Code like this gets tricky when you there is also a variable outside of the -class with the same name. Consider: +Code like this gets tricky when there is also a variable outside of the class +with the same name. Consider: :::wren var name = "variable" diff --git a/doc/site/community.markdown b/doc/site/community.markdown deleted file mode 100644 index e3a1edee..00000000 --- a/doc/site/community.markdown +++ /dev/null @@ -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 diff --git a/doc/site/contributing.markdown b/doc/site/contributing.markdown index b2577a97..2831f4a3 100644 --- a/doc/site/contributing.markdown +++ b/doc/site/contributing.markdown @@ -1,40 +1,52 @@ ^title Contributing -Wren is under active development and there's lots to do. We'd be delighted to -have you help! +Like the bird, Wren's ecosystem is small but full of life. Almost everything is +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, -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. +## Growing the ecosystem -## 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 -means, but I went with the most permissive license I could find. +If you do any of the above, let us know by adding it to the wiki. We like to +keep track of: -The source is developed [on GitHub][github]. My hope is that the codebase, -tests, and [documentation][docs] are easy to understand and contribute to. If -they aren't, that's a bug. +* [Applications][] that host Wren as a scripting language. +* [Modules][] written in Wren that others can use. +* [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 -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. +## Contributing to Wren -Also, writing code in Wren and seeing what problems you run into is incredibly -helpful. Embedding Wren in an application will also exercise lots of corners of -the system and highlight problems and missing features. +You're also more than welcome to contribute to Wren itself, both the core VM and +the command-line interpreter. The source is developed [on GitHub][github]. Our +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 -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 +### Finding something to hack on + +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. -## Hacking on docs +### Hacking on docs The [documentation][] is one of the easiest—and most important!—parts of Wren to contribute to. The source for the site is @@ -74,7 +86,7 @@ docs when you edit a file: :::sh $ make watchdocs -## Hacking on the VM +### Hacking on the VM 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 landed smoothly. +## Getting help + 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 -`stuffwithstuff.com`) if you want something less public. *Thank you!* +`stuffwithstuff.com`) if you want something less public. [mit]: http://opensource.org/licenses/MIT [github]: https://github.com/munificent/wren diff --git a/doc/site/template.html b/doc/site/template.html index 9f666ebe..89efafa2 100644 --- a/doc/site/template.html +++ b/doc/site/template.html @@ -23,7 +23,6 @@

language guide

@@ -57,7 +56,6 @@ Getting Started Contributing - Community

language guide