Commit graph

52 commits

Author SHA1 Message Date
Travis Ralston
c9619bfe48
Fix documentation to make yarn test work out of the box (mk II) ()
* Fix documentation to make `yarn test` work out of the box

Before, invoking `yarn test` croaked on a missing src/component-index.js
file. In another part of the README, the missing instruction to generate
this file was found.

* Fix CI: Unauthenticated git protocol on port 9418 is no longer supported

GitHub is deprecating the service which answered unauthenticated git
protocol requests. Either it happened already, or they are running
brownouts.

* This is where I meant to leave that comment

Co-authored-by: Andreas Motl <andreas.motl@panodata.org>
2021-11-02 20:22:24 +00:00
Elsie Hupp
89ef8e9441
Add convenience inline links to README.md ()
Signed-off-by: Elsie Hupp <9206310+elsiehupp@users.noreply.github.com>
2021-11-01 10:17:51 +00:00
Andy Balaam
842ab0af05 Remove extra 'are' in README
Signed-off-by: Andy Balaam <andyb@element.io>
2021-09-29 11:41:37 +01:00
Jano Garcia
b5d25eb5f8
Fix wrong URL in README.md 2021-07-30 14:10:47 +02:00
Šimon Brandner
39ef376a79
Use Android SDK instead
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2021-05-05 18:06:42 +02:00
Šimon Brandner
374d8c1c4c
Update link to Android SDK
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
2021-05-05 08:43:24 +02:00
J. Ryan Stinnett
640fe00d1e Update Weblate URL 2020-10-21 13:14:41 +01:00
Daniel Maslowski
bc0c30f99f fix link to classic yarn's yarn link
Signed-off-by: Daniel Maslowski <info@orangecms.org>
2020-09-29 04:46:59 +02:00
J. Ryan Stinnett
ce226ab534 Replace Riot with Element in docs and comments
This only covers the simple cases of references to issues and repos. More
complex areas, such as deployment scripts, will be handled separately.

Part of https://github.com/vector-im/element-web/issues/14864
2020-08-03 18:33:36 +01:00
J. Ryan Stinnett
cda691e359 Tweak Yarn docs link post-review 2020-05-13 11:29:11 +01:00
chagai95
d68b50feb6
Updated link and added:Yarn two is not yet used.
the link was broken and there was no mention of the version of yarn being used.
2020-05-13 11:49:26 +02:00
Jorik Schellekens
21a41fa343 Update link to css location. 2020-03-30 10:05:40 +01:00
Travis Ralston
74fcb103b1
Link to the right contributing guidelines 2020-03-05 11:04:33 -07:00
Travis Ralston
fde32f13a5 [CONFLICT CHUNKS] Merge branch 'develop' into travis/sourcemaps-develop 2020-01-09 14:15:09 -07:00
Pankaj Kumar Singh
a9cae90a52 Signed-off-by Pankaj Singh <singh.pankaj@live.com 2019-12-26 23:11:17 +05:30
Travis Ralston
9865ce899b Add a bunch of docs
We're making an assumption here that the decorator is actually all over the app when it's not.
2019-12-16 16:34:46 -07:00
Bruno Windels
e2e7303cc3
Update README.md
Co-Authored-By: J. Ryan Stinnett <jryans@gmail.com>
2019-10-18 12:29:17 +00:00
Bruno Windels
d20b2ee9eb document how to run the e2e tests locally 2019-10-10 16:54:10 +02:00
J. Ryan Stinnett
34e533dd4b Remove Edge from browser support statements
At the current time, we do not intend to do additional work specifically to
support Edge.  If it works for most use cases, that's great, but we do not
intend to fix issues that affect only Edge.

Fixes https://github.com/vector-im/riot-web/issues/9201
2019-03-18 15:47:48 +00:00
J. Ryan Stinnett
92a9f13452 Recommend using the latest Node LTS version 2019-03-13 10:53:53 +00:00
J. Ryan Stinnett
337ac2f6a0 Reorder link and install steps
Take advantage of Yarn's preservation of links while installing and set up links
first and install second. This should result in a small speedup since we no
longer install the published SDKs just to replace them on the next line.
2019-03-11 18:36:45 +00:00
J. Ryan Stinnett
7c947d87ab Update scripts and docs to use yarn where appropriate
Most `npm` operations are replaced with `yarn`, which generally has better
behavior. However, steps like publish that write to the NPM registry are left to
`npm`, which currently handles these tasks best.
2019-03-11 14:22:02 +00:00
Travis Ralston
633b8d419f
Mention node 8.x as recommended in development docs
Co-Authored-By: jaywink <mail@jasonrobinson.me>
2019-01-06 15:13:07 +02:00
Jason Robinson
e876edcbc3 Clarify readme instructions for developers
Setting up the SDK for development, I noticed that 3 tests failed on
develop branch. Linking the JS SDK made the tests pass. It looks like
the assumption is that developers link against the develop branch
of JS SDK to develop the React SDK.

Clarify this in the readme for completeness sake.

Signed-off-by: Jason Robinson <jasonr@matrix.org>
2019-01-04 11:01:35 +02:00
J. Ryan Stinnett
0b65a1ee1a Remove outdated info about custom skins
It has been marked outdated for several years. Since it appears on the repo home
page, it makes the project feel unmaintained.

Signed-off-by: J. Ryan Stinnett <jryans@gmail.com>
2018-12-06 19:25:07 -06:00
Matthew Hodgson
ef20813f2e remove layering warnings 2018-09-09 18:38:21 +01:00
rponline
27b594e1af Fix broken Link 2017-09-04 18:31:53 +02:00
krombel
00d69aa938 Update Link to Translation status
The translation is now done at translate.riot.im but the link was not updated
2017-08-15 00:32:38 +02:00
David Baker
107024efa8 Unnecessary whitespace 2017-05-25 11:42:19 +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
Matthew Hodgson
197c68c247 s/vector/riot/g 2016-12-21 22:45:57 +00:00
Matthew Hodgson
a8677b52ad major update to dev guidelines 2016-07-11 18:26:16 +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
David Baker
54048ee37c Update Readme 2015-10-01 16:02:21 +01: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