Add brew installation & contributing doc

This commit is contained in:
Vincent Prouillet 2017-11-01 16:31:58 +01:00
parent 11be340a92
commit 3f9d39481d
2 changed files with 13 additions and 6 deletions

View file

@ -16,9 +16,15 @@ in the `docs/content` folder of the repository.
- [Philipp Oppermann's blog](https://os.phil-opp.com/): https://github.com/phil-opp/blog_os/tree/master/blog - [Philipp Oppermann's blog](https://os.phil-opp.com/): https://github.com/phil-opp/blog_os/tree/master/blog
- [seventeencups](https://www.seventeencups.net): https://github.com/17cupsofcoffee/seventeencups.net - [seventeencups](https://www.seventeencups.net): https://github.com/17cupsofcoffee/seventeencups.net
## Adding syntax highlighting languages and themes ## Contributing
As the documentation site is automatically built on commits to master, all development
should happen on the `next` branch, unless it is fixing the current documentation.
### Adding a syntax If you want a feature added or modified, please open an issue to discuss it before doing a PR.
### Adding syntax highlighting languages and themes
#### Adding a syntax
Syntax highlighting depends on submodules so ensure you load them first: Syntax highlighting depends on submodules so ensure you load them first:
```bash ```bash
@ -51,7 +57,7 @@ And finally from the root of the components/rendering crate run the following co
$ cargo run --example generate_sublime synpack ../../sublime_syntaxes ../../sublime_syntaxes/newlines.packdump ../../sublime_syntaxes/nonewlines.packdump $ cargo run --example generate_sublime synpack ../../sublime_syntaxes ../../sublime_syntaxes/newlines.packdump ../../sublime_syntaxes/nonewlines.packdump
``` ```
### Adding a theme #### Adding a theme
A gallery containing lots of themes is located at https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark. A gallery containing lots of themes is located at https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark.
More themes can be easily added to gutenberg, just make a PR with the wanted theme added in the `sublime_themes` directory More themes can be easily added to gutenberg, just make a PR with the wanted theme added in the `sublime_themes` directory
and run the following command from the root of the components/rendering: and run the following command from the root of the components/rendering:

View file

@ -8,10 +8,11 @@ Gutenberg provides pre-built binaries for MacOS, Linux and Windows on the
## Mac OS ## Mac OS
Gutenberg is not currently available on Homebrew at the moment. Gutenberg is available on [Brew](https://brew.sh):
If you can help package it, please comment on [https://github.com/Keats/gutenberg/issues/12](https://github.com/Keats/gutenberg/issues/12) ```bash
if you encounter any issues. $ brew install gutenberg
```
## Windows ## Windows