Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
* fix screenshots path
* update contributing instructions
* general reformatting
  • Loading branch information
Rahul Bothra committed Aug 29, 2018
1 parent 4a3c5b2 commit c71d84d
Showing 1 changed file with 16 additions and 20 deletions.
36 changes: 16 additions & 20 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@
## Termi-Nalanda
### About:
It uses **bs4** and **requests** Libraries. It is used to access Nalanda - The E-Learning Management System for BITS Pilani, directly from the terminal. It displays notices which you **haven't seen earlier** using this.<br>It will also **download/update** the lecture slides and other resources for you.<br>
# nalanda-cli
Access nalanda from your terminal.<br>

### Requirements:
- Ubuntu
- Python2.7 or Python3.5+
- pip
![nalanda-cli](screenshots/demo.jpg)<br>

### Development:
If you want to contribute by solving any issue or adding a feature in this project, then keep in mind
1. The code should be according to PEP8 Standards
2. If a major feature/issue is being addressed, then use a new branch
3. The commit messages should be descriptive
## Requirements:
- Ubuntu 16.04 or later
- Python2.7
- pip

### Installation:
- Clone the repository. Open it in a terminal and run the install file: <br>
## Installation:
- Clone the repository. Open it a terminal and run install: <br>
```shell
./install
```
Expand All @@ -35,14 +30,15 @@ Eg: if your ID is 2016A7PS0015P, type in
```shell
Bits/2-1
```
### Usage:
![Installation](screenshots/install.jpg)<br>

## Usage:
Whenever, you want to see the Nalanda Updates or just download the slides, open a terminal and type:
```shell
nalanda
```

### Screenshots:
1. Installation
![Installation](src/res/install.jpg)<br>
2. Using termi-nalanda
![Demonstration](src/res/demo.jpg)<br>
## Contributing:
You can contribute by reporting bugs or solving the existing issues.
- follow PEP8 standards and flake8
- make descriptive commit messages for each change

0 comments on commit c71d84d

Please sign in to comment.