Commit 0bbfcdd3 authored by Omniscimus's avatar Omniscimus Committed by Michael Henretty

Minor changes in README and CONTRIBUTING (#488)

* Elaborate on the Discussion section in the README

* Minor changes to CONTRIBUTING.md
parent 47c4ed5d
......@@ -33,16 +33,7 @@ This will:
3. Save uploaded voice clips onto Amazon's S3.
4. Lint and rebuild all js files on every change.
#### Project Directory Structure
The project is organized into the following directories:
- *android*: The Android app, simple webview wrapper of voice.mozilla.org. This app is not currently published.
- *docs*: Design and data specifications for Common Voice.
- *ios*: The iOS app. At the time of it's publishing, this was a workaround for Safari not supporting getUserMedia.
- *nubis*: Configuration files for [Nubis](https://github.com/nubisproject), our deployment tool.
- *server*: The server-side code app logic written in NodeJS.
- *tools*: Just some scripts for managing data.
- *web*: The Common Voice website files.
You can then access the website at [http://localhost:9000](http://localhost:9000).
#### Need Help?
For more options, just type:
......@@ -50,6 +41,17 @@ For more options, just type:
gulp help
```
#### Project Directory Structure
The project is organized into the following directories:
- *android*: The Android app, a simple webview wrapper of voice.mozilla.org. This app is currently not published.
- *docs*: Design and data specifications for Common Voice.
- *ios*: The iOS app. This is a simple wrapper app for the website, as a workaround for a microphone issue in Safari.
- *nubis*: Configuration files for [Nubis](https://github.com/nubisproject), our deployment tool.
- *server*: The server-side app logic, written in [TypeScript](http://www.typescriptlang.org/).
- *tools*: Some scripts for managing data.
- *web*: The Common Voice website files, written in [TypeScript](http://www.typescriptlang.org/). We use [Preact](https://preactjs.com/) to build the website.
## Submitting an Issue
Did you notice a bug? Do you have a feature request? Please file an issue [here on GitHub](https://github.com/mozilla/voice-web/issues).
......
......@@ -6,6 +6,15 @@ donations for the Common Voice project.
[voice.mozilla.org](https://voice.mozilla.org)
### Contributing
From writing and reading sentences to enhancing our front-end architecture, there are many ways to get involved with Common Voice. For more information, check out [CONTRIBUTING.md](https://github.com/mozilla/voice-web/blob/master/CONTRIBUTING.md).
From writing and reading sentences to enhancing our front-end architecture, there are many ways to get involved with Common Voice. For more information, check out [CONTRIBUTING.md](./CONTRIBUTING.md).
Or for general discussion (feedback, ideas, random musings), head to our [Discourse Category](https://discourse.mozilla-community.org/c/voice).
### Discussion
For general discussion (feedback, ideas, random musings), head to our [Discourse Category](https://discourse.mozilla-community.org/c/voice).
For technical problems or suggestions, please use the [GitHub issue tracker](https://github.com/mozilla/voice-web/issues).
You can also chat on our IRC channel. Check [Mozilla IRC](https://wiki.mozilla.org/IRC) for instructions on how to set up your IRC client.
Hostname: `irc.mozilla.org`
Port: `6697` (or `8843` if your ISP blocks that port)
SSL: Yes
Channel: `#common-voice`
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment