Skip to content

Commit 4e0589b

Browse files
committed
docs: update some docs
1 parent 8d30b27 commit 4e0589b

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/SETUP.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@
77
5. Run `vagrant ssh` to login to the VM. Once inside, run `cd director` to change into the repo and `./scripts/install_dependencies.sh` to install Director's Python dependencies using Pipenv.
88
6. You can now work on Director. `scripts/start-servers.sh` will open a `tmux` session with the four servers each running in a separate pane.
99
- Note: If you are not familiar with `tmux`, we recommend https://www.hamvocke.com/blog/a-quick-and-easy-guide-to-tmux/ and https://tmuxcheatsheet.com/ as starting resources.
10+
- See [this](docs/tmux.md) for an explaination of the components of the development `tmux`
1011
7. When you are finished, type `exit` to exit the VM and `vagrant halt` to stop it. When you want to work on Director 4.0 again, `cd` into this directory, run `vagrant up` and `vagrant ssh` to launch the VM and connect to it, and then run `exit` and `vagrant halt` to exit and shut it down.

resources/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This contains a listing of resources that have been helpful to us.
44

55
## General
6-
* https://github.com/tjcsl/director
6+
* https://github.com/tjcsl/director - Inspiration for project
77

88
## Manager
99

@@ -18,3 +18,6 @@ This contains a listing of resources that have been helpful to us.
1818
* https://www.docker.com/blog/introducing-the-moby-project/ - This provides some insight into how the Docker project is designed.
1919
* https://github.com/moby/moby/blob/master/contrib/check-config.sh - This script checks whether your kernel supports all of Docker's features.
2020
* https://docs.docker.com/install/linux/docker-ce/ubuntu/ - Ubuntu install instructions
21+
22+
# asyncssh
23+
* https://asyncssh.readthedocs.io/

0 commit comments

Comments
 (0)