TOS scripts

This repo contains helper scripts for the TOS project
Explore the docs »

View Demo · Report Bug · Request Feature · TOS

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You need the following packages

• git
• bash
• python
• rofi
• feh
• bluez-utils
• gnupg
• networkmanager
• python-pywal
• pacman-contrib
• checkupdates-aur-tos
• imagemagick

Installation

1. Clone the helper-scripts

git clone https://github.com/ODEX-TOS/tools.git ~/bin

2. Install packages

pacman -Syu bash polybar-git rofi xorg-xrandr

3. Get emoji file

curl https://raw.githubusercontent.com/ODEX-TOS/dotfiles/master/emoji -o ~/.config/emoji

Make sure this repo is inside your path environment variable eg

export PATH=$HOME/bin:$PATH

Usage

We have a few usefull script in this repo

open

A small wrapper around xdg-open to launch applications for you.

open . # open current directory in vscode
open index.html # opens html pages in the browser
open blabla.pdf # opens pdf in zatura (or other pdf viewers)
open README.md # opens in typora a readme editor

rankmirror

A simple utility that will scan the arch repo servers and will reorder them based on speed. This way your updates will happen faster

rankmirror

tos

This is a very large tool that is not going to be explained here. See below for more information

Commit hooks

Before creating commits you need to setup commit hooks. These commit hooks perform a series of checks to make sure you didn't forget something important

This ranges from linting, license checks, correct usage of branching etc

It is not mandatory to use this feature, however it will make it more likely to be allowed.

Setting the commit hooks is as easy as executing the following commands from the project root:

ln -s "$PWD"/hooks/pre-commit .git/hooks/pre-commit
ln -s "$PWD"/hooks/commit-msg .git/hooks/commit-msg
ln -s "$PWD"/hooks/pre-push .git/hooks/pre-push

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Tom Meyers - [email protected]

Project Link: https://github.com/ODEX-TOS/tools

Acknowledgements

• F0xedb