David Baker
d4aa428321
Move translation status image to i18n section
2017-05-24 14:23:34 +01:00
David Baker
dd1c50ce80
README formatting
...
Move translation status to its own heading
2017-05-23 15:30:36 +01:00
David Baker
d419c42a4f
Squash merge https://github.com/matrix-org/matrix-react-sdk/pull/801
2017-05-23 15:16:31 +01:00
David Baker
6b6fa59f3e
Squash merge https://github.com/vector-im/riot-web/pull/3636
2017-05-23 14:12:53 +01:00
David Baker
68a39b2783
Update process to not set deps to #develop
...
Update README instructions and add checks to release script to
prevent us forgetting to bump the versions of dependencies
(because the check in the main release script will only catch
references to #develop left in, which will no longer be the
failure mode).
2017-05-19 11:59:27 +01:00
Michael Telatynski
1ed1080bf3
Update README with npm run electron
...
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2017-05-05 17:05:03 +01:00
Michael Telatynski
9e2324fb69
don't hook on postinstall, current dev cycle uses (abuses) npm i to build
...
so no point making it take longer than it has to for the devs only testing
webapp
build:electron - hook npm run install:electron
install:electron - run npm i for the electron deps
electron - start the app locally for testing
add to README
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2017-04-23 22:50:58 +01:00
Matthew Hodgson
e40c6905dd
more instructions
2017-04-01 13:33:24 +01:00
Matthew Hodgson
84a0ef9695
spell out that if you're on develop you need to keep your deps up-to-date
2017-04-01 13:25:16 +01:00
Tom Lant
927d305ed9
Fixing triage markdown as per #3382
2017-03-09 14:36:56 +00:00
David Baker
feb8115d24
Desktop instructions: npm run build, not dist
...
Clarify that you only need to run build rather than dist to run
the electron app.
Hopefully satisfies: https://github.com/vector-im/riot-web/pull/3237
2017-02-20 10:32:14 +00:00
Matthew Hodgson
5469270e41
spell out where the PGP key lives for releases
2017-02-18 23:48:58 +02:00
David Baker
3c91f90dc9
Tweak desktop instructions ( #3069 )
...
to make it clear you need to do all the things in 'building from
source', including the build-react-sdk dance if you're building
develop.
2017-01-26 09:47:01 +00:00
David Baker
3023ea5335
Merge branch 'release-v0.9.6'
2017-01-16 13:34:41 +00:00
Hubert Chathi
ccf7db7cc2
Fix a couple more references to vector-web in README.md
2017-01-13 15:06:29 -05:00
David Baker
27e311f7e8
Address PR comments
2017-01-11 18:15:06 +00:00
David Baker
5258bf9c84
Update README now the js-sdk has a transpile step
2017-01-11 17:25:58 +00:00
Hubert Chathi
d1a9695a35
update README to point to new names/locations
2016-12-28 20:57:31 -05:00
Matthew Hodgson
6e0f83a298
Merge branch 'release-v0.9.5'
2016-12-24 19:29:42 +00:00
Matthew Hodgson
8c523be6f5
add gnu-tar to debian electron build deps
2016-12-24 19:03:46 +00:00
Matthew Hodgson
b06d045188
Merge pull request #2808 from vector-im/matthew/electron-captcha2
...
make electron send email validation URLs with a nextlink of riot.im
2016-12-24 18:38:29 +00:00
Matthew Hodgson
f2afcc0bc8
add gnu-tar to debian electron build deps
2016-12-24 18:13:20 +00:00
Kevin McDonald
2b70cb436e
add Debian Stretch install steps to readme
2016-12-23 22:32:16 -07:00
joelostblom
e741a4f294
Update desktop build instructions fixes #2792
...
This is based on what I had to do to get the desktop app running, as per the advice in https://github.com/vector-im/riot-web/issues/2792 . I am not familiar with `npm`, so please change this pull request if there is a more appropriate way of achieving the same result.
2016-12-22 14:53:03 -05:00
Matthew Hodgson
197c68c247
s/vector/riot/g
2016-12-21 22:45:57 +00:00
Mikaela Suomalainen
9ae86f2585
README.md: fix GFMD for nativefier
...
GitHub Flavoured MarkDown parsed this as
`sudo npm install nativefier -g nativefier https://riot.im/app/ ` which
is incorrect.
2016-12-17 21:17:58 +02:00
David Baker
994bc9279f
Remove the client side filtering from the room dir
...
This removes the ability for the client to filter remote room
directories by network, since the /thirdparty/protocols API does
not yet work for remote servers. They would only get the main list
now though anyway, so there is no point in us continuing to support
it.
2016-12-16 14:17:13 +00:00
David Baker
f5bd8abfda
Support room dir 3rd party network filtering
...
As per https://github.com/matrix-org/synapse/pull/1676
The existing local config system still exists and is used for
remote home server directories (since /thirdparty/protocols
doesn't support listing remote home servers, and also because
people are using it).
2016-12-14 15:41:15 +00:00
David Baker
119e03b64f
Get the update base URL right
...
and update the text in the README.
2016-12-12 17:24:22 +00:00
David Baker
fe574b008b
Credit aviral & other options for native riot
2016-12-09 19:05:25 +00:00
David Baker
f7cd5cb76f
Update README to say how to build the desktop app
2016-12-09 18:29:06 +00:00
David Baker
970a029cea
Merge remote-tracking branch 'origin/develop' into dbkr/electron_dist_tweaks
2016-12-02 14:32:31 +00:00
David Baker
749d26c8f4
Link to the repo which it turns out is a thing
2016-12-02 14:25:20 +00:00
David Baker
d0c2ab4cf1
Document cross_origin_renderer_url
2016-12-02 13:43:41 +00:00
David Baker
9f51e2c407
Auto-update & build process with NSIS for windows
...
Amalgamate the electron build packaging into one script.
Use update_base_url so we can compute the actual URL in the
script for windows (because we need to put it in the build) and
at runtime for mac os.
2016-12-01 19:33:42 +00:00
David Baker
6a944d3e7d
Fix config location in some more places
2016-11-30 18:09:51 +00:00
David Baker
db07ef7899
Update readme to point to github releases
...
not /packages
2016-11-02 12:01:01 +00:00
David Baker
f17e851435
Rename the package script/output dir to 'dist'
...
To match conventions from other projects and match the release
script which expects releasde artefacts in dist/
2016-11-01 15:22:06 +00:00
Richard van der Hoff
e0556789d2
readme tweaks
...
Note that Chrome requires https for voip (fixes #2506 )
Remove lies about where issues are filed.
2016-10-25 11:20:23 +01:00
David Baker
9310d92605
document integrations config in README
2016-10-21 14:59:13 +01:00
Richard van der Hoff
d72323bfc5
typo
2016-10-20 17:05:44 +01:00
Richard van der Hoff
dfd0356609
s/vector/riot/ in the readme
...
Also remove the outdated "E2E" section
Fixes https://github.com/vector-im/vector-web/issues/2457
2016-10-20 16:54:30 +01:00
David Baker
562b047362
Typo
2016-10-05 13:49:30 +01:00
David Baker
381c9009fb
Doc roomDirectory config section
2016-10-04 16:21:39 +01:00
Richard van der Hoff
e8a12e7ddc
Revert "fix instructions"
...
This reverts commit 6a13155013
2016-09-16 17:27:52 +01:00
Matthew Hodgson
6a13155013
fix instructions
2016-09-16 17:08:27 +01:00
Matthew Hodgson
0aae88d753
nudge jenkins
2016-08-30 14:40:30 +01:00
Matthew Hodgson
13983900c0
clarify electron instructions
2016-08-27 22:21:52 +01:00
Matthew Hodgson
e06caa9ca1
mention not just a problem for Vector
2016-08-27 00:13:56 +01:00
Matthew Hodgson
efc5462131
warn people to put their Matrix HS on a separate domain
2016-08-27 00:13:20 +01:00
Richard van der Hoff
f2936dc15c
Update encryption info in README
2016-08-23 18:07:07 +01:00
David Baker
678393e2bd
Add note about file table overflows
2016-08-12 09:59:56 +01:00
Matthew Hodgson
d4faacf462
clear up IS ambiguity and close https://github.com/vector-im/vector-web/issues/1720
2016-07-31 23:42:34 +01:00
Matthew Hodgson
fd53f10fbd
improve the getting started instructions and plug the electron apps
2016-07-28 16:05:21 +02:00
Matthew Hodgson
80ad45df06
spell out that vector should not depend on the public net
2016-07-15 15:57:59 +01:00
Matthew Hodgson
a8677b52ad
major update to dev guidelines
2016-07-11 18:26:16 +01:00
Matthew Hodgson
fef81748bb
major update to dev guidelines
2016-07-11 18:25:58 +01:00
Richard van der Hoff
bb820bebd1
README: fix some lies
...
Take out a few misleading things from the readme.
2016-06-20 14:36:40 +01:00
David Baker
a373849b5b
Give better instructions for modifying config.
2016-06-15 11:03:52 +01:00
David Baker
a8cee87c08
js-sdk doesn't have a build step
2016-06-14 15:53:13 +01:00
David Baker
a7598ea815
Mention copying sample file here too
2016-06-14 15:52:03 +01:00
David Baker
22cef7a6a0
Copy config.json first
2016-06-14 15:41:55 +01:00
David Baker
b643d8ff6a
Update README.md
...
To reflect the fact that you can now sensibly deploy from a package (ie. be able to configure the app). Make the first thing be downloading a prebuilt package so people who only read the first part don't end up running npm start in production and complain about needing npm.
2016-06-14 15:12:35 +01:00
Ruben Barkow
bccee9b8a0
Correct Readme instructions how to customize the UI
...
As at the moment the Readme does not explain the structure of the code any more, the Readme has to be actualized.
(This is just a draft, to keep track of this Issue)
2016-04-23 11:00:48 +02:00
Richard van der Hoff
da7e9840f3
reinstate npm 3 warning
2016-03-11 15:12:28 +00:00
Richard van der Hoff
cc18458bec
Update README to include npm install in react-sdk
...
Casual users of /develop shouldn't need to do the whole
clone-three-repositories thing.
2016-03-11 15:09:29 +00:00
David Baker
642c33e8d9
Mention package script in readme
2016-02-25 10:47:09 +00:00
David Baker
ef00bc6d56
Manually merge relevant remaining parts of https://github.com/vector-im/vector-web/pull/790 that aren't covered by @richvdh's PR.
2016-02-24 11:59:29 +00:00
David Baker
1ecedd2769
Add back deployment info
2016-02-24 11:48:51 +00:00
David Baker
9c9e260410
Make the README more idiot-proof
2016-02-24 11:36:57 +00:00
Richard van der Hoff
ca89c09e73
formatting
2016-02-23 21:00:27 +00:00
Richard van der Hoff
10f6277de2
Update the README to make the development instructions clearer
2016-02-23 20:55:37 +00:00
David Baker
ab9dfd185c
Add note to not use npm start in production
2016-02-04 18:43:23 +00:00
Richard van der Hoff
f8e5bbef0b
Add a link to E2E bug in the README
2015-12-08 16:03:12 +00:00
Richard van der Hoff
759e35003b
Put some warnings on the crypto stuff
2015-12-04 15:39:39 +00:00
Richard van der Hoff
56b7b65920
Notes on building a crypto-enabled version
2015-12-03 18:25:20 +00:00
Matthew Hodgson
92728ff4e6
spell out npm run build
2015-11-22 01:13:08 +00:00
Matthew Hodgson
731881ee7b
fix language
2015-10-25 12:35:52 +00:00
Matthew Hodgson
47dca51c38
spell out how to set up the deps when developing
2015-10-25 12:33:13 +00:00
Matthew Hodgson
5844fb4020
spell out that developers need to use npm link
2015-10-25 11:56:29 +00:00
Matthew Hodgson
a05437e81f
add npm i source-map-loader troubleshooting step
2015-10-10 18:51:22 +01:00
David Baker
df39c3a281
Changes from PR feedback
2015-10-02 16:44:35 +01:00
David Baker
7b9cd7c232
Update readme
2015-10-01 16:02:44 +01:00
David Baker
54048ee37c
Update Readme
2015-10-01 16:02:21 +01:00
Matthew Hodgson
56c5f6f46e
clarify deployment
2015-09-19 20:17:45 +01:00
Matthew Hodgson
2d1b88e50d
use right paths
2015-07-28 16:30:01 +01:00
David Baker
8c25855f38
Tweak README for vector
2015-07-21 22:45:01 -07:00
Matthew Hodgson
49e687f584
typo
2015-07-12 14:09:53 +01:00
Matthew Hodgson
e3f42dcd5e
more overview
2015-07-08 11:35:40 +01:00
Matthew Hodgson
c346a27e6f
matrix ain't just chat
2015-07-08 11:33:04 +01:00
Matthew Hodgson
ba68810a87
fix english
2015-07-08 11:25:11 +01:00
Matthew Hodgson
b170bc2cb2
clarify skinning semantics
2015-07-08 11:15:25 +01:00
David Baker
6c81a8d46d
Add blurb on how to build a customised app.
2015-07-07 18:27:34 +01:00
Matthew Hodgson
df4c5c588a
define skins
2015-07-07 18:04:31 +01:00
Matthew Hodgson
15c93b61aa
try to write down the various naming & architectural conventions that the SDK adheres to...
2015-07-07 17:46:18 +01:00
David Baker
be9d8f1768
Correct docs again: you do need to npm install the react sdk root explicitly
2015-07-06 18:58:32 +01:00
David Baker
3e87e043d6
Fix docs
2015-07-06 18:29:24 +01:00
David Baker
6c35908949
Add example shwing how to customise, make customising work and document all the ways in which browserify will break and how to work around it being dumb.
2015-07-06 14:13:02 +01:00
David Baker
275286801b
Add npm link to the README
2015-07-03 16:15:23 +01:00
David Baker
3a68748320
Almost
2015-07-03 15:57:35 +01:00
David Baker
dff74f44de
Tweak the example build process. Move example -> examples/trivial to we can have more than one. Update README appropriately.
2015-07-03 15:56:04 +01:00
David Baker
e5a4e5b195
Add more detail to the getting started instructions.
2015-06-24 17:58:13 +01:00
Brennan Novak
76cc258dde
added instructions to README
2015-06-24 17:33:53 +02:00
David Baker
c42733ec95
Basic structure of a react SDK and start of an implementation.
2015-06-09 17:40:42 +01:00
