From 3f9d39481d50c8da5acbae7be215fcfe2dbf10fe Mon Sep 17 00:00:00 2001 From: Vincent Prouillet Date: Wed, 1 Nov 2017 16:31:58 +0100 Subject: [PATCH] Add brew installation & contributing doc --- README.md | 12 +++++++++--- .../documentation/getting-started/installation.md | 7 ++++--- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d3ed604..e79e803 100644 --- a/README.md +++ b/README.md @@ -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 - [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: ```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 ``` -### Adding a theme +#### Adding a theme 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 and run the following command from the root of the components/rendering: diff --git a/docs/content/documentation/getting-started/installation.md b/docs/content/documentation/getting-started/installation.md index 7382165..c43a965 100644 --- a/docs/content/documentation/getting-started/installation.md +++ b/docs/content/documentation/getting-started/installation.md @@ -8,10 +8,11 @@ Gutenberg provides pre-built binaries for MacOS, Linux and Windows on the ## 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) -if you encounter any issues. +```bash +$ brew install gutenberg +``` ## Windows