@@ -12,17 +12,17 @@ a 'skin'. A skin provides:
12
12
* Zero or more 'modules' containing non-UI functionality
13
13
14
14
** WARNING: As of July 2016, the skinning abstraction is broken due to rapid
15
- development of ` matrix-react-sdk ` to meet the needs of Vector, the first app
16
- to be built on top of the SDK** (https://github.com/vector-im/vector -web ).
17
- Right now ` matrix-react-sdk ` depends on some functionality from ` vector -web`
18
- (e.g. CSS), and ` matrix-react-sdk ` contains some Vector specific behaviour
19
- (grep for 'vector'). This layering will be fixed asap once Vector development
15
+ development of ` matrix-react-sdk ` to meet the needs of Riot (codenamed Vector) , the first app
16
+ to be built on top of the SDK** (https://github.com/vector-im/riot -web ).
17
+ Right now ` matrix-react-sdk ` depends on some functionality from ` riot -web`
18
+ (e.g. CSS), and ` matrix-react-sdk ` contains some Riot specific behaviour
19
+ (grep for 'vector'). This layering will be fixed asap once Riot development
20
20
has stabilised, but for now we do not advise trying to create new skins for
21
21
matrix-react-sdk until the layers are clearly separated again.
22
22
23
- In the interim, ` vector-im/vector -web ` and ` matrix-org/matrix-react-sdk ` should
23
+ In the interim, ` vector-im/riot -web ` and ` matrix-org/matrix-react-sdk ` should
24
24
be considered as a single project (for instance, matrix-react-sdk bugs
25
- are currently filed against vector-im/vector -web rather than this project).
25
+ are currently filed against vector-im/riot -web rather than this project).
26
26
27
27
Developer Guide
28
28
===============
@@ -44,15 +44,15 @@ https://github.com/matrix-org/synapse/tree/master/CONTRIBUTING.rst
44
44
Please follow the Matrix JS/React code style as per:
45
45
https://github.com/matrix-org/matrix-react-sdk/tree/master/code_style.rst
46
46
47
- Whilst the layering separation between matrix-react-sdk and Vector is broken
47
+ Whilst the layering separation between matrix-react-sdk and Riot is broken
48
48
(as of July 2016), code should be committed as follows:
49
49
* All new components: https://github.com/matrix-org/matrix-react-sdk/tree/master/src/components
50
- * Vector -specific components: https://github.com/vector-im/vector -web/tree/master/src/components
50
+ * Riot -specific components: https://github.com/vector-im/riot -web/tree/master/src/components
51
51
* In practice, ` matrix-react-sdk ` is still evolving so fast that the maintenance
52
- burden of customising and overriding these components for Vector can seriously
53
- impede development. So right now, there should be very few (if any) customisations for Vector .
54
- * CSS for Matrix SDK components: https://github.com/vector-im/vector -web/tree/master/src/skins/vector/css/matrix-react-sdk
55
- * CSS for Vector -specific overrides and components: https://github.com/vector-im/vector -web/tree/master/src/skins/vector/css/vector -web
52
+ burden of customising and overriding these components for Riot can seriously
53
+ impede development. So right now, there should be very few (if any) customisations for Riot .
54
+ * CSS for Matrix SDK components: https://github.com/vector-im/riot -web/tree/master/src/skins/vector/css/matrix-react-sdk
55
+ * CSS for Riot -specific overrides and components: https://github.com/vector-im/riot -web/tree/master/src/skins/vector/css/riot -web
56
56
57
57
React components in matrix-react-sdk are come in two different flavours:
58
58
'structures' and 'views'. Structures are stateful components which handle the
@@ -76,7 +76,7 @@ practices that anyone working with the SDK needs to be be aware of and uphold:
76
76
77
77
* The view's CSS file MUST have the same name (e.g. view/rooms/MessageTile.css).
78
78
CSS for matrix-react-sdk currently resides in
79
- https://github.com/vector-im/vector -web/tree/master/src/skins/vector/css/matrix-react-sdk .
79
+ https://github.com/vector-im/riot -web/tree/master/src/skins/vector/css/matrix-react-sdk .
80
80
81
81
* Per-view CSS is optional - it could choose to inherit all its styling from
82
82
the context of the rest of the app, although this is unusual for any but
@@ -129,7 +129,7 @@ from it.
129
129
Github Issues
130
130
=============
131
131
132
- All issues should be filed under https://github.com/vector-im/vector -web/issues
132
+ All issues should be filed under https://github.com/vector-im/riot -web/issues
133
133
for now.
134
134
135
135
OUTDATED: To Create Your Own Skin
0 commit comments