浏览代码

doc: move development sections to standalone file

master
Saúl Ibarra Corretgé 5 年前
父节点
当前提交
3469d5dc4f
共有 2 个文件被更改,包括 80 次插入79 次删除
  1. 2
    79
      README.md
  2. 78
    0
      doc/development.md

+ 2
- 79
README.md 查看文件

31
 * [Android](https://play.google.com/store/apps/details?id=org.jitsi.meet)
31
 * [Android](https://play.google.com/store/apps/details?id=org.jitsi.meet)
32
 * [iOS](https://itunes.apple.com/us/app/jitsi-meet/id1165103905)
32
 * [iOS](https://itunes.apple.com/us/app/jitsi-meet/id1165103905)
33
 
33
 
34
-## Building the sources
34
+## Development
35
 
35
 
36
-Node.js >= 10 and npm >= 6 are required.
37
-
38
-On Debian/Ubuntu systems, the required packages can be installed with:
39
-```
40
-sudo apt-get install npm nodejs
41
-cd jitsi-meet
42
-npm install
43
-```
44
-
45
-To build the Jitsi Meet application, just type
46
-```
47
-make
48
-```
49
-
50
-### Working with the library sources (lib-jitsi-meet)
51
-
52
-By default the library is build from its git repository sources. The default dependency path in package.json is :
53
-```json
54
-"lib-jitsi-meet": "jitsi/lib-jitsi-meet",
55
-```
56
-
57
-To work with local copy you must change the path to:
58
-```json
59
-"lib-jitsi-meet": "file:///Users/name/local-lib-jitsi-meet-copy",
60
-```
61
-
62
-To make the project you must force it to take the sources as 'npm update':
63
-```
64
-npm install lib-jitsi-meet --force && make
65
-```
66
-
67
-Or if you are making only changes to the library:
68
-```
69
-npm install lib-jitsi-meet --force && make deploy-lib-jitsi-meet
70
-```
71
-
72
-Alternative way is to use [npm link](https://docs.npmjs.com/cli/link).
73
-It allows to link `lib-jitsi-meet` dependency to local source in few steps:
74
-
75
-```bash
76
-cd lib-jitsi-meet
77
-
78
-#### create global symlink for lib-jitsi-meet package
79
-npm link
80
-
81
-cd ../jitsi-meet
82
-
83
-#### create symlink from the local node_modules folder to the global lib-jitsi-meet symlink
84
-npm link lib-jitsi-meet
85
-```
86
-
87
- After changes in local `lib-jitsi-meet` repository, you can rebuild it with `npm run install` and your `jitsi-meet` repository will use that modified library.
88
-Note: when using node version 4.x, the make file of jitsi-meet do npm update which will delete the link. It is no longer the case with version 6.x.
89
-
90
-If you do not want to use local repository anymore you should run
91
-```bash
92
-cd jitsi-meet
93
-npm unlink lib-jitsi-meet
94
-npm install
95
-```
96
-### Running with webpack-dev-server for development
97
-
98
-Use it at the CLI, type
99
-```
100
-make dev
101
-```
102
-
103
-By default the backend deployment used is `beta.meet.jit.si`. You can point the Jitsi-Meet app at a different backend by using a proxy server. To do this, set the WEBPACK_DEV_SERVER_PROXY_TARGET variable:
104
-```
105
-export WEBPACK_DEV_SERVER_PROXY_TARGET=https://your-example-server.com
106
-make dev
107
-```
108
-
109
-The app should be running at https://localhost:8080/
36
+For web development see [here](doc/development.md), and for mobile see [here](doc/mobile.md).
110
 
37
 
111
 ## Contributing
38
 ## Contributing
112
 
39
 
130
 The [meet.jit.si](https://meet.jit.si) service is maintained by the Jitsi team
57
 The [meet.jit.si](https://meet.jit.si) service is maintained by the Jitsi team
131
 at [8x8](https://8x8.com).
58
 at [8x8](https://8x8.com).
132
 
59
 
133
-## Mobile app
134
-Jitsi Meet is also available as a React Native app for Android and iOS.
135
-Instructions on how to build it can be found [here](doc/mobile.md).
136
-
137
 ## Acknowledgements
60
 ## Acknowledgements
138
 
61
 
139
 Jitsi Meet started out as a sample conferencing application using Jitsi Videobridge. It was originally developed by ESTOS' developer Philipp Hancke who then contributed it to the community where development continues with joint forces!
62
 Jitsi Meet started out as a sample conferencing application using Jitsi Videobridge. It was originally developed by ESTOS' developer Philipp Hancke who then contributed it to the community where development continues with joint forces!

+ 78
- 0
doc/development.md 查看文件

1
+# Developing Jitsi Meet
2
+
3
+## Building the sources
4
+
5
+Node.js >= 10 and npm >= 6 are required.
6
+
7
+On Debian/Ubuntu systems, the required packages can be installed with:
8
+```
9
+sudo apt-get install npm nodejs
10
+cd jitsi-meet
11
+npm install
12
+```
13
+
14
+To build the Jitsi Meet application, just type
15
+```
16
+make
17
+```
18
+
19
+### Working with the library sources (lib-jitsi-meet)
20
+
21
+By default the library is build from its git repository sources. The default dependency path in package.json is :
22
+```json
23
+"lib-jitsi-meet": "jitsi/lib-jitsi-meet",
24
+```
25
+
26
+To work with local copy you must change the path to:
27
+```json
28
+"lib-jitsi-meet": "file:///Users/name/local-lib-jitsi-meet-copy",
29
+```
30
+
31
+To make the project you must force it to take the sources as 'npm update':
32
+```
33
+npm install lib-jitsi-meet --force && make
34
+```
35
+
36
+Or if you are making only changes to the library:
37
+```
38
+npm install lib-jitsi-meet --force && make deploy-lib-jitsi-meet
39
+```
40
+
41
+Alternative way is to use [npm link](https://docs.npmjs.com/cli/link).
42
+It allows to link `lib-jitsi-meet` dependency to local source in few steps:
43
+
44
+```bash
45
+cd lib-jitsi-meet
46
+
47
+#### create global symlink for lib-jitsi-meet package
48
+npm link
49
+
50
+cd ../jitsi-meet
51
+
52
+#### create symlink from the local node_modules folder to the global lib-jitsi-meet symlink
53
+npm link lib-jitsi-meet
54
+```
55
+
56
+ After changes in local `lib-jitsi-meet` repository, you can rebuild it with `npm run install` and your `jitsi-meet` repository will use that modified library.
57
+Note: when using node version 4.x, the make file of jitsi-meet do npm update which will delete the link. It is no longer the case with version 6.x.
58
+
59
+If you do not want to use local repository anymore you should run
60
+```bash
61
+cd jitsi-meet
62
+npm unlink lib-jitsi-meet
63
+npm install
64
+```
65
+### Running with webpack-dev-server for development
66
+
67
+Use it at the CLI, type
68
+```
69
+make dev
70
+```
71
+
72
+By default the backend deployment used is `beta.meet.jit.si`. You can point the Jitsi-Meet app at a different backend by using a proxy server. To do this, set the WEBPACK_DEV_SERVER_PROXY_TARGET variable:
73
+```
74
+export WEBPACK_DEV_SERVER_PROXY_TARGET=https://your-example-server.com
75
+make dev
76
+```
77
+
78
+The app should be running at https://localhost:8080/

正在加载...
取消
保存