aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <florian.bigard@gmail.com>2016-07-22 11:45:48 +0200
committerChocobozzz <florian.bigard@gmail.com>2016-07-22 11:45:48 +0200
commit6dde6a31e3dfb0298e3f7171b2f8ad9bab1f2370 (patch)
treee77935a72c258cb14caf7fb3d95a9c5f857257b3
parent7a7edb72413077da772414507fbf1097fb8f3677 (diff)
downloadPeerTube-6dde6a31e3dfb0298e3f7171b2f8ad9bab1f2370.tar.gz
PeerTube-6dde6a31e3dfb0298e3f7171b2f8ad9bab1f2370.tar.zst
PeerTube-6dde6a31e3dfb0298e3f7171b2f8ad9bab1f2370.zip
Add CONTRIBUTING links to README
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index e089954c8..c5911bc6d 100644
--- a/README.md
+++ b/README.md
@@ -139,14 +139,14 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
139 139
140### Development 140### Development
141 141
142 $ npm start 142 $ npm run dev
143 143
144### Test with 3 fresh nodes 144### Test with 3 fresh nodes
145 145
146 $ npm run clean:server:test 146 $ npm run clean:server:test
147 $ npm run play 147 $ npm run play
148 148
149Then you will can access to the three nodes at `http://localhost:900{1,2,3}`. If you call "make friends" on `http://localhost:9002`, the pod 2 and 3 will become friends. Then if you call "make friends" on `http://localhost:9001` it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :) 149Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. If you call "make friends" on `http://localhost:9002`, the pod 2 and 3 will become friends. Then if you call "make friends" on `http://localhost:9001` it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :)
150 150
151### Production 151### Production
152 152
@@ -170,6 +170,13 @@ To print all available command run:
170 170
171You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution. 171You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution.
172 172
173## Contributing
174
175See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
176
177See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
178
179
173## Architecture 180## Architecture
174 181
175See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication. 182See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.