Skip to content

Commit

Permalink
📝 update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AmineDjeghri committed Dec 30, 2023
1 parent c6222bd commit 14da7e7
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
![Logo](docs/images/logo.png)

![Windows WSL Terminal](docs/images/windows_wsl_terminal.png)

| Windows WSL Terminal | Desktop with terminals |
|---------------------------------------------------------------|--------------------------------------------------------------------|
| ![Windows WSL Terminal](docs/images/windows_wsl_terminal.png) | ![Desktop with terminals](docs/images/desktop_with_terminals.jpeg) |


<div style="text-align: center;">The image you are looking at is a screenshot of a WSL Ubuntu terminal in Windows 11. The top bar is an app called GlazeWM which is a a tiling WM that lets you organize windows and adjust their layout on the fly by using keyboard-driven commands.
Expand Down
Binary file added docs/images/desktop_with_terminals.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion docs/unix_workflow/README_unix.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Linux setup

![Desktop with terminals](../images/desktop_with_terminals.jpeg)

A set of configurations, dotfiles and a script to automatically set up a powerful terminal & shell utilities(zsh, fzf...), themes like Powerlvl10k, Conda, GPU drivers, and more on Linux/WSL2.

I developed this tool to streamline the setup process when working on various servers, such as AWS instances and not having to install everything manually every time.
Expand All @@ -7,7 +10,7 @@ While it's particularly useful for Python developers, feel free to customize it

## Step 1 - Terminal customization :
- Download and install the [Firacode font](https://github.com/ryanoasis/nerd-fonts/releases/download/v3.1.1/FiraCode.zip) on your primary operating system (Windows if you are using WSL).
- Configure your terminal to utilize the newly installed font. For Windows, check this [link](windows_workflow/README.md#232-inswindows-terminalins). For Linux ##TODO.
- Configure your terminal to utilize the newly installed font. For Windows, check this [link](../windows_workflow/README_windows.md#232-inswindows-terminalins). For Linux ##TODO.
## Step 2 - Run the script :
- Run this command & choose what to install: oh-my-zsh, pl10k theme, miniconda & cuda (if you have a GPU) automatically:
```bash
Expand Down

0 comments on commit 14da7e7

Please sign in to comment.