https://github.com/akshat-owo/syllabusx

Interactive CLI for syllabusx
https://github.com/akshat-owo/syllabusx

Last synced: 9 days ago
JSON representation

Interactive CLI for syllabusx

• Host: GitHub
• URL: https://github.com/akshat-owo/syllabusx
• Owner: akshat-OwO
• License: gpl-3.0
• Created: 2024-01-17T16:19:00.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-01-23T12:28:18.000Z (12 months ago)
• Last Synced: 2024-05-01T14:06:53.710Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 137 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![image](https://github.com/akshat-OwO/syllabusx/assets/27628105/3e05962d-29b2-495b-b39e-5e8a8651ebc8)



  A CLI (Command-Line-Interface) version for SyllabusX .



# Introduction

The CLI version of SyllabusX is a small side-project that allows users to access the content on their desktops/laptops without having to open their web browsers. The project is in it's initial stage and will get more convinient to use in the future. 



# Installation

Steps to download and install the package:

1. Make sure you have npm package installed on your machine.

2. Open your command-line in Windows or terminal in Linux/MacOS.

3. Run this command ``npx syllabusx`` .

The package will get installed and the program will be up and running.

# Usage

- Use the arrow keys to browse up and down the options.

- Press spacebar to check mark any topic that you want.

- Press ctrl+C to go back