Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DerBunman committed Nov 16, 2019
1 parent 7282587 commit f6e1899
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 9 deletions.
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,35 +71,52 @@ Also note, that the oomox sources are included so you are able to customize the
### Basic install (like in the video)
These instructions have been tested on Ubuntu 19.10.

#### Before you start, you'll need to setup a password for the ansible-vault.
```sh
test -e ~/.ansible_vault_password || openssl rand -base64 20 > /home/ichi/.ansible_vault_password
chmod 400 ~/.ansible_vault_password
```

#### Then you can clone the repository.
```sh
cd ~
sudo apt-get install ansible git
git clone https://github.com/DerBunman/DieBenutzerumgebung --branch=master --single-branch
git clone https://github.com/DerBunman/DieBenutzerumgebung --branch=master --single-branch ~/DieBenutzerumgebung
```

#### And then you'll setup your environment.
```sh
cd ~/DieBenutzerumgebung/inventories/
cp localhost.yml default.yml
# edit default.yml according your needs
# edit default.yml according your needs.
# the minimal change would be to replace your_user with the current user.
# eg:
sed "s/your_user/$USER/" -i default.yml
cd ..
cp secrets.example.yml secrets.yml
ansible-vault encrypt secrets.yml
ansible-vault edit secrets.yml
ansible-galaxy install -r requirements.yml
```

#### Finally run the ansible playbook.
```sh
ansible-playbook playbook.yml --ask-become-pass
```

Done. Just logout and login again using the i3 session.

# Media
## Videos:
Example installation process on a fresh installed Ubuntu 19.10 VM.
### Example installation process on a fresh installed Ubuntu 19.10 VM.

<a href="https://www.youtube.com/watch?v=hHKy1tsied8" target="_blank">
<a href="https://www.youtube.com/watch?v=lV1Vl4LM4Bo" target="_blank">
<img src="docs/images/video_installation.png" />
</a>
<br>

Demonstration of the integrated screen recording features.
### Demonstration of some basic features.

<a href="https://www.youtube.com/watch?v=TX9MOrnscxs" target="_blank">
<img src="docs/images/video_mediamenu.png" />
<a href="https://www.youtube.com/watch?v=ckCV6jqcAS4" target="_blank">
<img src="docs/images/video_overview.png" />
</a>

## Screenshots:
Expand Down
Binary file added docs/images/video_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f6e1899

Please sign in to comment.