diff --git a/README.md b/README.md index 79cba6f..35de0a6 100644 --- a/README.md +++ b/README.md @@ -7,45 +7,3 @@ The docs aim to be *self-sufficient* — a complete reference for SomeWM users ## License Documentation is licensed under the GNU General Public License, version 3 or later. See [LICENSE](LICENSE). Portions are derived from the AwesomeWM project (GPL v2 or later); see [ATTRIBUTION.md](ATTRIBUTION.md). - -## Local development - -Built with [Docusaurus](https://docusaurus.io/). - -## Installation - -```bash -yarn -``` - -## Local Development - -```bash -yarn start -``` - -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -## Build - -```bash -yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -Using SSH: - -```bash -USE_SSH=true yarn deploy -``` - -Not using SSH: - -```bash -GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.