From 8b439630256e410084466bca56f6f672dee97dec Mon Sep 17 00:00:00 2001 From: BarsTiger Date: Fri, 11 Feb 2022 14:40:17 +0200 Subject: [PATCH] Updated README for docs --- .gitignore | 1 + README.md | 24 +++++------------------- docs/developers/gui-uploading.md | 7 +------ 3 files changed, 7 insertions(+), 25 deletions(-) diff --git a/.gitignore b/.gitignore index b2d6de3..9c0d0c3 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ # Generated files .docusaurus .cache-loader +package-lock.json # Misc .DS_Store diff --git a/README.md b/README.md index d3a1b99..d205279 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,18 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +If you want to add something to this website to make docs better, please open a pull request on GitHub. + ### Installation ``` -$ yarn +$ npm i ``` ### Local Development ``` -$ yarn start +$ npm 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. @@ -19,23 +21,7 @@ This command starts a local development server and opens up a browser window. Mo ### Build ``` -$ yarn build +$ npm run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. - -### Deployment - -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: - -``` -$ 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. diff --git a/docs/developers/gui-uploading.md b/docs/developers/gui-uploading.md index 16f9257..eb6bf37 100644 --- a/docs/developers/gui-uploading.md +++ b/docs/developers/gui-uploading.md @@ -47,9 +47,4 @@ If you don't have login in config, you will be asked to login. ## Logging in So, you have an account. -When prompted, enter your email and password. - -You will see -``` -[OK] Auth created -``` +//TODO