Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fedejaure committed Sep 22, 2024
1 parent 99d1b2a commit 7cca794
Show file tree
Hide file tree
Showing 11 changed files with 185 additions and 66 deletions.
74 changes: 8 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,73 +20,15 @@ My own Ansible collection for development setup (use by your own risk).

### Mac OS

#### Applications installed with Mac App Store

* [Xcode](https://apps.apple.com/us/app/id497799835)
* [Slack](https://apps.apple.com/us/app/id803453959)
* [WhatsApp](https://apps.apple.com/us/app/id310633997)
* [Telegram](https://apps.apple.com/us/app/id747648890)

#### Applications installed with Homebrew Cask

* [Firefox](https://www.mozilla.org/en-US/firefox/new/)
* [Google Chrome](https://www.google.com/chrome/)
* [Docker](https://www.docker.com/)
* [Openvpn Client](https://openvpn.net/vpn-client/)
* [dockutil](https://github.com/kcrawford/dockutil)
* [Visual Studio Code](https://code.visualstudio.com/)
* [Terminess Nerd Font](https://www.nerdfonts.com/)
* [Ubuntu Nerd Font](https://www.nerdfonts.com/)
* [xkcd Font](https://github.com/ipython/xkcd-font)
* [Zoom](https://zoom.us/)
* [Tad](https://www.tadviewer.com/)
* [Keybase](https://keybase.io/)
* [Obsidian](https://obsidian.md/)
* [Ultimaker Cura](https://ultimaker.com/software/ultimaker-cura)
* [Elgato Stream Deck](https://www.elgato.com/en/stream-deck-mk2)
* [Spotify](https://www.spotify.com/us/download/)
* [Alacritty](https://alacritty.org/)
* [Discord](https://discord.com/)

#### Tools/Package installed with Homebrew

* [git](https://git-scm.com/)
* [openssl](https://www.openssl.org/)
* [readline](https://tiswww.case.edu/php/chet/readline/rltop.html)
* [xz](https://tukaani.org/xz/)
* [sqlite](https://sqlite.org/index.html)
* [gcc](https://gcc.gnu.org/)
* [cmake](https://cmake.org/)
* [zlib](https://www.zlib.net/)
* [tcl-tk](https://www.tcl.tk/)
* [pipx](https://pypa.github.io/pipx/)
* [luarocks](https://luarocks.org/)
* [neovim](https://neovim.io/)
* [tmux](https://github.com/tmux/tmux/wiki)
* [chezmoi](https://www.chezmoi.io/)
* [lazydocker](https://github.com/jesseduffield/lazydocker)
* [sshpass](https://sourceforge.net/projects/sshpass/)
* [htop](https://htop.dev/)
* [dust](https://github.com/bootandy/dust)
* [duf](https://github.com/muesli/duf)
* [bat](https://github.com/sharkdp/bat)
* [Fish Shell](https://fishshell.com/)
* [Starship](https://starship.rs/)

#### Tools installed with pipx

* [pipenv](https://pipenv.pypa.io/en/latest/)
* [cookiecutter](https://github.com/cookiecutter/cookiecutter)
* [poetry](https://python-poetry.org/) with:
- [Poetry Plugin: Export](https://github.com/python-poetry/poetry-plugin-export)
* [nox](https://nox.thea.codes/en/stable/) with:
- [nox-poetry](https://nox-poetry.readthedocs.io/en/stable/)

#### Other installed Tools

* [oh-my-zsh](https://ohmyz.sh/)
* [pyenv](https://github.com/pyenv/pyenv)
- [x] Applications installed with Mac App Store.
- [x] Applications installed with Homebrew Cask.
- [x] Tools/Package installed with Homebrew.
- [x] Tools installed with pipx.
- [x] Custom installed Tools.

### Linux

Comming soon ...

## Quickstart

Expand Down
18 changes: 18 additions & 0 deletions docs/features/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Features

## MacOS

The current implementation for macOS includes:

- Installation of applications via the Mac App Store.
- Installation of tools and applications via Homebrew.
- Installation of Python tools using `pipx`.
- Installation of custom tools and configurations.

[Explore macOS features](macos/index.md)

## Linux

Linux support is under development and will be available soon.

[Explore Linux features](linux/index.md)
3 changes: 3 additions & 0 deletions docs/features/linux/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Linux

Comming soon ...
36 changes: 36 additions & 0 deletions docs/features/macos/homebrew_cask.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Homebrew Cask

## Browsers
- [**Firefox**](https://www.mozilla.org/en-US/firefox/new/): A fast, privacy-focused web browser.
- [**Google Chrome**](https://www.google.com/chrome/): A widely used browser with extensive extensions and features.

## Development
- [**Docker**](https://www.docker.com/): A platform for developing, shipping, and running applications in containers.
- [**Visual Studio Code**](https://code.visualstudio.com/): A powerful code editor with support for numerous programming languages and extensions.
- [**Alacritty**](https://alacritty.org/): A fast, GPU-accelerated terminal emulator.

## Communication
- [**Discord**](https://discord.com/): A voice and text chat platform for communities and teams.
- [**Keybase**](https://keybase.io/): A secure messaging and file-sharing app.
- [**Zoom**](https://zoom.us/): A video conferencing tool for meetings and webinars.

## Networking
- [**OpenVPN Client**](https://openvpn.net/vpn-client/): A versatile VPN client for secure internet connections.

## Design and Productivity
- [**Obsidian**](https://obsidian.md/): A knowledge base that works on local Markdown files.

## Font Packages
- [**Terminess Nerd Font**](https://www.nerdfonts.com/): A patched version of popular fonts with added glyphs.
- [**Ubuntu Nerd Font**](https://www.nerdfonts.com/): A modified Ubuntu font with extra glyphs.
- [**xkcd Font**](https://github.com/ipython/xkcd-font): A font inspired by the xkcd comic.

## Utilities
- [**dockutil**](https://github.com/kcrawford/dockutil): A command-line utility for managing the macOS Dock.
- [**Tad**](https://www.tadviewer.com/): A tool for visualizing and exploring data.
- [**Ultimaker Cura**](https://ultimaker.com/software/ultimaker-cura): A 3D printing slicer software.
- [**Elgato Stream Deck**](https://www.elgato.com/en/stream-deck-mk2): A customizable control pad for streamers and content creators.
- [**Spotify**](https://www.spotify.com/us/download/): A popular music streaming service.

???+ note "Customization Options"
You can customize your installation by adding or removing applications as needed. For more information on how to override default settings, visit our [Work in Progress (WIP) customization guide](#).
41 changes: 41 additions & 0 deletions docs/features/macos/homebrew_packages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Homebrew Packages

## Development Tools

- [**Git**](https://git-scm.com/): A distributed version control system to manage source code efficiently.
- [**GCC**](https://gcc.gnu.org/): A compiler system supporting various programming languages, such as C, C++, and Fortran.
- [**CMake**](https://cmake.org/): A cross-platform build system that manages the build process across different platforms.

## System Utilities

- [**OpenSSL**](https://www.openssl.org/): A robust toolkit for the implementation of secure communication using the SSL/TLS protocols.
- [**Readline**](https://tiswww.case.edu/php/chet/readline/rltop.html): A library for command-line editing, providing a rich set of text-editing features.
- [**XZ**](https://tukaani.org/xz/): A compression library that provides high-compression ratios.
- [**SQLite**](https://sqlite.org/index.html): A self-contained SQL database engine that is lightweight and highly reliable.
- [**zlib**](https://www.zlib.net/): A general-purpose data compression library.
- [**Tcl/Tk**](https://www.tcl.tk/): A scripting language and toolkit for GUI development.
- [**Sshpass**](https://sourceforge.net/projects/sshpass/): A non-interactive password provider for SSH that allows for automated SSH connections.

## Package Management

- [**Pipx**](https://pypa.github.io/pipx/): A tool for installing and running Python applications in isolated environments.
- [**LuaRocks**](https://luarocks.org/): A package manager for the Lua programming language.

## Terminal Tools

- [**Neovim**](https://neovim.io/): A highly extensible text editor based on Vim, with improved usability and performance.
- [**Tmux**](https://github.com/tmux/tmux/wiki): A terminal multiplexer that lets you switch between multiple programs in a single terminal.
- [**Chezmoi**](https://www.chezmoi.io/): A cross-platform tool for managing your dotfiles.
- [**Lazydocker**](https://github.com/jesseduffield/lazydocker): A simple terminal UI for managing Docker containers and images.
- [**Bat**](https://github.com/sharkdp/bat): A cat command clone with syntax highlighting and Git integration.
- [**Htop**](https://htop.dev/): An interactive process viewer for Unix systems.
- [**Dust**](https://github.com/bootandy/dust): A disk usage tool written in Rust.
- [**Duf**](https://github.com/muesli/duf): A user-friendly command-line utility to view disk usage information.

## Shell and Terminal Customization

- [**Fish Shell**](https://fishshell.com/): A user-friendly, interactive shell with features like syntax highlighting, autosuggestions, and better scripting.
- [**Starship**](https://starship.rs/): A cross-shell prompt that is fast and highly customizable.

???+ note "Customization Options"
You can customize your installation by adding or removing applications as needed. For more information on how to override default settings, visit our [Work in Progress (WIP) customization guide](#).
9 changes: 9 additions & 0 deletions docs/features/macos/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# MacOs

The default macos setup automates installation of:

- [**Mac App Store Apps**](mas.md): Install popular apps like Xcode, Slack, and more from the Mac App Store.
- [**Homebrew Cask Apps**](homebrew_cask.md): Use Homebrew Cask to install non-App Store applications, such as Chrome and Docker.
- [**Homebrew Packages**](homebrew_packages.md): Install crucial command-line tools and libraries like Git, OpenSSL, and Python via Homebrew.
- [**pipx Tools**](pipx.md): Manage Python-based command-line tools using pipx, ensuring isolated and clean installations.
- [**Custom Tools**](other_tools.md): Tools that are not easily installed by other means.
12 changes: 12 additions & 0 deletions docs/features/macos/mas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Mac App Store Applications

## Development
- [**Xcode**](https://apps.apple.com/us/app/id497799835): Apple's official IDE for macOS and iOS development, providing tools for coding, testing, and debugging.

## Communication
- [**Slack**](https://apps.apple.com/us/app/id803453959): A collaboration platform for team communication and project management.
- [**WhatsApp**](https://apps.apple.com/us/app/id310633997): A messaging app for quick communication with team members and clients.
- [**Telegram**](https://apps.apple.com/us/app/id747648890): A secure messaging app known for its speed and file-sharing capabilities.

???+ note "Customization Options"
These applications are included by default, but you can customize your installation to fit your specific needs. For more information on how to override default settings, visit our [Work in Progress (WIP) customization guide](#).
9 changes: 9 additions & 0 deletions docs/features/macos/other_tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Custom Installed Tools

## Development

- [**pyenv**](https://github.com/pyenv/pyenv): A popular tool for managing multiple Python versions. It allows you to easily switch between different Python versions, making it easier to work on projects with varying dependencies.

## Shell and Terminal Customization

- [**Oh My Zsh**](https://ohmyz.sh/): A powerful framework for managing your Zsh configuration. It comes with a vast collection of plugins and themes, making your terminal more productive and visually appealing.
14 changes: 14 additions & 0 deletions docs/features/macos/pipx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Pipx

## Development

- [**Pipenv**](https://pipenv.pypa.io/en/latest/): A tool that simplifies dependency management and virtual environments for Python projects. It aims to bring the best of all packaging worlds (bundling, development workflow, etc.) to the Python world.
- [**Poetry**](https://python-poetry.org/): A modern Python package and dependency manager, helping you build, publish, and manage your projects. Installed with:
- [**Poetry Plugin: Export**](https://github.com/python-poetry/poetry-plugin-export): Allows Poetry to export the environment and project dependencies in various formats (e.g., requirements.txt).
- [**Cookiecutter**](https://github.com/cookiecutter/cookiecutter): A utility that generates project boilerplate based on templates. It helps streamline the creation of new projects with predefined structures and configurations.
- [**Nox**](https://nox.thea.codes/en/stable/): An automation tool for Python testing that can run test suites in different environments. Installed with:
- [**Nox-Poetry**](https://nox-poetry.readthedocs.io/en/stable/): A plugin that integrates Poetry into Nox, allowing seamless management of testing environments and dependencies.


???+ note "Customization Options"
You can customize your installation by adding or removing applications as needed. For more information on how to override default settings, visit our [Work in Progress (WIP) customization guide](#).
8 changes: 8 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
title: dev-setup - My own Ansible collection for development setup
hide:
- toc
- navigation
- feedback
---

# Welcome to dev-setup

My own Ansible collection for development setup (use by your own risk).
27 changes: 27 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,20 @@ extra:
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by
using our <a href="https://github.com/fedejaure/dev-setup/issues/new?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">filing an issue</a>.
social:
- icon: fontawesome/brands/github
link: https://github.com/fedejaure
Expand Down Expand Up @@ -123,6 +137,8 @@ markdown_extensions:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde

# Page tree
Expand All @@ -133,4 +149,15 @@ nav:
- Contributing: contributing.md
- Code of Conduct: code_of_conduct.md
- License: license.md
- Features:
- features/index.md
- MacOS:
- features/macos/index.md
- Mac App Store: features/macos/mas.md
- Homebrew Cask: features/macos/homebrew_cask.md
- Homebrew Packages: features/macos/homebrew_packages.md
- Pipx: features/macos/pipx.md
- Other Tools: features/macos/other_tools.md
- Linux:
- features/linux/index.md
- Changelog: changelog.md

0 comments on commit 7cca794

Please sign in to comment.