From 6dde6a31e3dfb0298e3f7171b2f8ad9bab1f2370 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Fri, 22 Jul 2016 11:45:48 +0200 Subject: [PATCH] Add CONTRIBUTING links to README --- README.md | 11 +++++++++-- 1 file 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 ### Development - $ npm start + $ npm run dev ### Test with 3 fresh nodes $ npm run clean:server:test $ npm run play -Then 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 :) +Then 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 :) ### Production @@ -170,6 +170,13 @@ To print all available command run: You 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. +## Contributing + +See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md). + +See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md). + + ## Architecture See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.