Git Product home page Git Product logo

.alx-automation's Introduction

.alx-automation

This automation tool will help you quickly get through all the ALX assignments. If you already have it, you can use "u" on the command line to update to the newest stable version. The stable channel is updated weekly.

Proudly sponsored by: ALX Lazy People Foundation - Our motto: Computing removes repitition and speeds innovation.

*Always remember to change your the default directory to your preferred directory after every install, reinstall or update.

Installation

Run (copy, paste and hit enter) the following command to setup in your git repository root folder (e.g ~/alx-low_level_programming).

wget -q -O setup.sh https://l.sapiens.ng/setup && chmod u+x setup.sh && ./setup.sh

Intro and setup video

Usage

The following command line aliases have the following effects within your repo root folder:

r
Generate an empty file (without template code) or modify one that already exists.

r c
Generate or modify a c source file.

r h
Generate or modify a c header file.

r bash
Generate or modify a bash script file.

e
Edit the script for the automation tool.

  • To change referenced working directory, change the $DIR_PATH variable on line #3. see Edit before use section for more details.

d
Unistall the automation tool.

u
Update the script to the newest version.

Warning

Edit before use:

By default the script will add new files to the ./default_directory. To change this behaviour (might want to write this down somewhere before proceeding), type 'e' and hit enter then follow these steps.

STEP 1:

Type 'i' to edit the file

STEP 2:

Change the DIR_PATH=./previous_directory variable on the first line to DIR_PATH=./desired_directory (Hint: its given as Directory: 0x0... in the question)

STEP 3:

Hit the 'esp' key to leave edit mode

STEP 4:

Type ':wq' to write changes and close the file

Version and feature update information

We try to have weekly updates to this project. You can use "u" alias to update easily from your terminal.

Feature list

  • (One tool to rule them all) Automatically create multiple working folder in git repo root folder for each new project.
  • Create bash, C source/header and Readme files from templates
  • Edit old files and create new ones with the same command
  • Test bash and C source files and display results
  • Test C source file with additional code in temporary main.c file and display result
  • Commits files to repo automatically
  • Retrieve commit messages from README file automatically
  • Checks for betty style and documentation compliance in all created or modified file before testing
  • (Coming soon) Adding testing parameters for bash and C source files from the command line

v3.1.0

  • Update to uninstall and update scripts
  • New feature to optonally commit header files immediately
  • New display format for c source results
  • Update to C source and header templates

v3.0.1

  • Updates to C template.

v3.0.0

  • Architecture redesign

FAQ

  • How to copy and paste on Ubunto 20.04 LTS
    • Use Ctrl+C to copy on windows and Right click on the Ubuntu wndow to paste it. (For debian linux (e.g. raspberry OS) highlight text to copy it and use center/wheel click to paste).
  • I'm having trouble updating the script with "u".
    • As a brute force method, use rm -r .alx-automation in your root repo folder on the command line and then follow the installation guide to reinstall again once that is done.

.alx-automation's People

Contributors

mechtanium avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.