gaja-group
/
matrix-bot
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

README: fix some lies 

Take out a few misleading things from the readme.
This commit is contained in:
Richard van der Hoff 2016-06-20 10:52:56 +01:00
parent 664f809362
commit bb820bebd1
1 changed files with 3 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -22,7 +22,7 @@ Building From Source
If you do wish to build vector from source: If you do wish to build vector from source:
1. Install or update `node.js` so that your `npm` is at least at version `2.0.0` 1. Install or update `node.js` so that your `npm` is at least at version `2.0.0`
1. Clone the repo: `git clone https://github.com/vector-im/vector-web.git` 1. Clone the repo: `git clone https://github.com/vector-im/vector-web.git`
1. Switch to the vector directory: `cd vector-web` 1. Switch to the vector directory: `cd vector-web`
1. Install the prerequisites: `npm install` 1. Install the prerequisites: `npm install`
1. If you are using the `develop` branch of vector, you will probably need to 1. If you are using the `develop` branch of vector, you will probably need to
@ -60,8 +60,6 @@ Much of the functionality in Vector is actually in the `matrix-react-sdk` and
easy to track the `develop` branches in git and to make local changes without easy to track the `develop` branches in git and to make local changes without
having to manually rebuild each time. having to manually rebuild each time.
[Be aware that there may be problems with this process under npm version 3.]
First clone and build `matrix-js-sdk`: First clone and build `matrix-js-sdk`:
1. `git clone git@github.com:matrix-org/matrix-js-sdk.git` 1. `git clone git@github.com:matrix-org/matrix-js-sdk.git`
@ -123,10 +121,7 @@ day-to-day use; it is experimental and should be considered only as a
proof-of-concept. See https://matrix.org/jira/browse/SPEC-162 for an overview proof-of-concept. See https://matrix.org/jira/browse/SPEC-162 for an overview
of the current progress. of the current progress.
To build a version of vector with support for end-to-end encryption, install Vector is built with support for end-to-end encryption by default.
the olm module with `npm i https://matrix.org/packages/npm/olm/olm-0.1.0.tgz`
before running `npm start`. The olm library will be detected and used if
available.
To enable encryption for a room, type To enable encryption for a room, type
@ -142,4 +137,4 @@ Note that historical encrypted messages cannot currently be decoded - history
is therefore lost when the page is reloaded. is therefore lost when the page is reloaded.
There is currently no visual indication of whether encryption is enabled for a There is currently no visual indication of whether encryption is enabled for a
room, or whether a particular message was encrypted. room.