Skip to content

Latest commit

 

History

History
99 lines (63 loc) · 2.21 KB

README.md

File metadata and controls

99 lines (63 loc) · 2.21 KB

Scripts Collection

Welcome to the scripts repository! This is a curated collection of scripts in Shell, Python, Ruby, and more to help you automate tasks and improve productivity.

Contents

  1. About
  2. Installation
  3. Usage
  4. Testing
  5. Contribution
  6. License

1. About

This repository contains various utility scripts to address common tasks efficiently. Whether you are an experienced developer or just getting started, you'll find tools to optimize your workflow.

Supported languages:

  • Shell
  • Python (requires version 3.6 or later)
  • Ruby

2. Installation

Clone the Repository

Run the following commands to clone and navigate into the repository:

git clone https://github.com/id774/scripts.git
cd scripts

Set Up Environment

To simplify usage, set the $SCRIPTS environment variable:

export SCRIPTS='/path/to/scripts'

Add this line to your .bashrc or .zshrc to persist the configuration.

Grant Permissions

Ensure all scripts have the correct permissions:

./setup_scripts.sh

3. Usage

Refer to the comments at the beginning of each script for usage instructions. Example:

$SCRIPTS/example_script.sh

4. Testing

To validate the repository's integrity, run:

./run_tests.sh

This script will:

  • Verify the presence of Python and Ruby.
  • Run all test files in the test directory.
  • Output paths and versions for troubleshooting.

5. Contribution

We welcome contributions! Here's how you can help:

  1. Fork the repository.
  2. Add or improve a feature, or fix an issue.
  3. Submit a pull request with clear documentation and changes.

Please ensure your code is well-structured and documented.

6. License

This repository is dual licensed under the GPL version 3 or the LGPL version 3, at your option. For full details, please refer to the LICENSE file. See also COPYING and COPYING.LESSER for the complete license texts.

Thank you for using and contributing to this repository!