Skip to content

update development instructions #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shreyansh-Mishra wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update development instructions #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 17 additions & 74 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,87 +6,30 @@ See the inauguration post - http://iiitv.github.io/blog/welcome-to-the-blog.html

The design is drawn from [@ansarimofid's work](https://github.com/ansarimofid/blog-iiitv).

## Development Instructions
<h2 align="center">Development Instructions</h2>

### 1. Clone the repository
### Requirements:

* Open terminal and type the following
```
git clone https://github.com/iiitv/iiitv.github.com.git
```

### 2. Go to the local repository on your system

* Assuming your repository is on the Desktop
* Open terminal
* If your terminal is at home, do the following
```
cd Desktop/iiitv.github.com/
```
* But if you are already at desktop just type
```
cd iiitv.github.com/
```
* Git
* Ruby v2.1+
Copy link
Copy Markdown
Member

@anujpuri72 anujpuri72 Sep 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

u can add link to download them here

* Jekyll (Gem Package)
* Redcarpet (Gem Package)
* GCC with Make

### 3. Install Jekyll to your system
### Installation:

You could do this in two ways-
1. Follow the steps given by [Jekyll](https://jekyllrb.com/docs/installation/).
2. Follow the instructions below:
Assuming you have Git and Ruby with Gem Installed, open the terminal and type:

#### To install Jekyll on your system you need the following

* GNU/Linux, Unix, or macOS
* Ruby version 2.1 or above, including all development headers
* RubyGems
* GCC and Make (in case your system doesn’t have them installed, which you can check by running gcc -v and make -v in your system’s command line interface)

#### (i) How to install Ruby

* Follow the steps given by [Ruby](https://www.ruby-lang.org/en/documentation/installation/).

###### Or if you are using apt (Debian or Ubuntu)

* Debian GNU/Linux and Ubuntu use the apt package manager. You can use it like this
```bash
git clone https://github.com/iiitv/iiitv.github.com.git
cd iiitv.github.com/
gem install jekyll
gem install redcarpet
```
sudo apt-get install ruby-full
```

#### (ii) How to install RubyGems

* Follow the steps given by [RubyGems](https://rubygems.org/pages/download/).
### Running:

###### Or do the following
```
gem install rubygems-update
update_rubygems
```

#### (iii) How to install Jekyll

###### Do the following

```
gem install jekyll
```

#### (iv) You also need to install Redcarpet

###### To install redcarpet do the following
```
sudo gem install redcarpet
```

### 4. Running the project

* Assuming your terminal is at your repository.
* If not follow step 2.

##### To run the project

* Do the following
```
```bash
jekyll serve
```
* This command will run the project on default ``` localhost:4000 ```.
* Open any browser and go to the address ``` localhost:4000 ```.
* To preview the project, visit ```http://localhost:4000/```.