Matrix-Mirrors/schildi-web
1
0
Fork 0
mirror of https://github.com/SchildiChat/element-web.git synced 2024-10-01 01:26:12 -04:00
Code Issues Packages Projects Releases Wiki Activity

Remove mention of CI scripts from docs

Browse Source 
This removes `fetch-develop.deps.sh` from the docs, as it's designed more for
use on CI environments and ends up causing confusion when used for anything
else.

Fixes https://github.com/vector-im/riot-web/issues/11247
This commit is contained in:
J. Ryan Stinnett 2019-10-29 10:37:36 +00:00
parent 6ada5e4397
commit 2c0559dbea
1 changed files with 5 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -73,26 +73,11 @@ guide](https://yarnpkg.com/docs/install/) if you do not have it already.
1. Clone the repo: `git clone https://github.com/vector-im/riot-web.git`. 1. Clone the repo: `git clone https://github.com/vector-im/riot-web.git`.
1. Switch to the riot-web directory: `cd riot-web`. 1. Switch to the riot-web directory: `cd riot-web`.
1. Install the prerequisites: `yarn install`. 1. Install the prerequisites: `yarn install`.
1. If you're using the `develop` branch then it is recommended to set up a proper * If you're using the `develop` branch, then it is recommended to set up a
development environment ("Setting up a dev environment" below) however one can proper development environment (see [Setting up a dev
install the develop versions of the dependencies instead: environment](#setting-up-a-dev-environment) below). Alternatively, you
```bash can use https://riot.im/develop - the continuous integration release of
scripts/fetch-develop.deps.sh the develop branch.
```
Whenever you git pull on `riot-web` you will also probably need to force an update
to these dependencies - the simplest way is to re-run the script, but you can also
manually update and rebuild them:
```bash
cd matrix-js-sdk
git pull
yarn install # re-run to pull in any new dependencies
cd ../matrix-react-sdk
git pull
yarn install
```
Or just use https://riot.im/develop - the continuous integration release of the
develop branch. (Note that we don't reference the develop versions in git directly
due to https://github.com/npm/npm/issues/3055.)
1. Configure the app by copying `config.sample.json` to `config.json` and 1. Configure the app by copying `config.sample.json` to `config.json` and
modifying it. See the [configuration docs](docs/config.md) for details. modifying it. See the [configuration docs](docs/config.md) for details.
1. `yarn dist` to build a tarball to deploy. Untaring this file will give 1. `yarn dist` to build a tarball to deploy. Untaring this file will give