Skip to content

Latest commit

 

History

History
165 lines (111 loc) · 4.02 KB

README.md

File metadata and controls

165 lines (111 loc) · 4.02 KB
Raw

VITable-CLI

A CLI that shows classes right in Terminal for you. Written in Nim.

DOCS

Caution

  • The working of this for 2021-2025 batch students has NOT been extensively tested. Reporting any bugs is appreciated.
  • If you're a '25 batch student and don't see your course, please contact one of the maintainers and get your courses added.

Screenshot

VITable

Features

  • Shows all classes
  • Shows ongoing classes
  • Shows next class
  • Shows classes today

Instructions to install (Unix Based Systems)

You will need to install Nim on your host PC in order to run VITable.

Linux

Debian based operating systems -

sudo apt install nim -y

And on Arch Linux -

sudo pacman -S nim

After installing Nim, run the following.

git clone "https://github.com/CartelProject/VITable-CLI"
touch timetable.txt
cd VITable-CLI
make build

Now, to make it visible throughout system

sudo cp src/vitable /usr/bin
vitable -h

NOTE: On Arch Linux, vitable can be installed using the AUR!

Instructions to install (Windows)

Dependencies

These steps are for installing in the D drive

Note Please, copy the contents of your timetable from VTOP -> Academics -> Time Table to timetable.

Run the next steps in an elevated command shell

C:\WINDOWS\system32> choco install make

Restart Terminal (Not necessarily elevated)

D:\> mkdir Tools
D:\Tools> cd Tools
D:\Tools> git clone "https://github.com/CartelProject/VITable-CLI"
D:\Tools> type nul >> C:\Users\%username%\timetable.txt
D:\Tools> cd VITable-CLI
D:\Tools\VITable-CLI> make build
D:\Tools\VITable-CLI> set PATH=%PATH%;"D:\Tools\VITable-CLI\src"
D:\Tools\VITable-CLI> vitable -h

Congratulations, VITable should be up and running now!

Instructions to Install (Android)

Dependencies for Android

  • A Terminal Emulator (Example: Termux, Termius)
  • A timetable.txt file (Preferable to first install on a desktop and transfer that file to mobile.)

Preferred Installation Method

Pre-Requisites

  • Download & Install Termux
  • Download & Install Termux-API
  • Install the Termux API package
pkg install termux-api
  • Assuming you have transferred the timetable.txt file from your desktop, run this command and allow permissions.
termux-setup-storage
  • Now we save the External timetable.txt file to the local termux file storage.
termux-storage-get timetable.txt
  • After running that command, navigate to the timetable.txt you have transferred from your desktop.

Configuration

  • Installing nim and make.
pkg install root-repo
apt update && apt upgrade -y
apt install nim -y
pkg install make
  • Cloning the Repository
git clone "https://github.com/CartelProject/VITable-CLI"
cd VITable-CLI
  • Installing
make build
cd src
cp src/vitable $HOME
./vitable

Note: You may face an SSL Error, (1416F086), No fix for it is currently known. Troubleshooting includes, checking if your date/time is synced, disabling any AV's and VPN's and signing a new certificate.

Contributors

License

This application is licensed under the Cartel Project Public License.

Made with ❤️ by The Cartel Family