Skip to content
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

Jump to bottom

Improve README.md #1

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Improve README.md #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ecdee1a
Improve `README.md`
Panquesito7 Sep 2, 2021
7079932
Merge branch 'main' into improve_readme
Panquesito7 Sep 13, 2021
efc324e
Update according to what @IhyUnited suggested
Panquesito7 Sep 13, 2021
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
58 changes: 26 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@

## Features

- ### **Easy to Setup 💯**
- ### **Free to Use ( OpenSource ) 🥳**
- ### **No Additional Frameworks 🤘**
- ### **No Additional Libraries 🙌**
- ### **Multi Page 💎**
- ### **Fully Responsive 🚀**
- ### **Super Fast and Optimized for SEO ⚡**
- ### **Great Audits Score 🎖️**
- ### **Easy-to-use** 🥑
- ### **Free to Use ( OpenSource ) 🥳**
- ### **Multi-page 💎**
- ### **Fully Responsive 🚀**
- ### **No Additional Libraries** 🤘
- ### **No Additional Frameworks** 🙌
- ### **Super Fast and Optimized for SEO ⚡**
- ### **Great Audits Score** 🎖️

<img src="https://i.ibb.co/1dD8Mky/Screenshot-from-2021-08-28-14-38-30.png" alt="Dopefolio Audits" width="100%" />

Expand Down Expand Up @@ -71,9 +71,7 @@ $ git remote remove origin

<br/>

Then you can install the dependencies

Using NPM:
Then you can install the dependencies using NPM:

```bash
# Install dependencies
Expand All @@ -91,9 +89,9 @@ Once you run `npm run compile:scss`, then you can open the `index.html` inside y

<br>

## Template Instructions:
## Template Instructions

## Step 1 - STYLES
### Step 1 - STYLES

Make sure you have started the SASS to CSS compilation by running

Expand All @@ -118,11 +116,11 @@ $themeClrPrimary: #0062b9;

<br/>

## Step 2 - Homepage
### Step 2 - Homepage

Go to `/index.html` and fill your information, there are 6 sections:

### Header of Homepage
#### Header of Homepage

- On `.header__logo-img`, Add your own Image, Better if the background of the image is transparent so the background can match the theme color. To remove the background of your image, you can visit remove.bg where you can upload your image and it will remove the background of it.
- On `.header__logo-sub`, Add your own Name.
Expand Down Expand Up @@ -190,7 +188,7 @@ Go to `/index.html` and fill your information, there are 6 sections:
<!-- END Header -->
```

### Hero Section of Homepage
#### Hero Section of Homepage

- On `.heading-primary`, put your custom title.
- On `.text-primary`, put a short description about yourself.
Expand Down Expand Up @@ -269,7 +267,7 @@ Go to `/index.html` and fill your information, there are 6 sections:
<!-- /END Hero Section -->
```

### About Section
#### About Section

- On `.heading-sec__sub`, put a short description about the section.
- On `.about__content-details-para`, put your details here and use `<strong></strong>` tag to highlight specific keywords.
Expand Down Expand Up @@ -335,7 +333,7 @@ Go to `/index.html` and fill your information, there are 6 sections:
<!-- END About Section -->
```

### Projects
#### Projects

- On `.heading-sec__sub`, put a short description about the section.
- `.projects__row` is the row for each project in your portfolio.
Expand Down Expand Up @@ -439,7 +437,7 @@ Currently, I have already added a separate for each project ( considering there
<!-- END Projects Section -->
```

### Contact Section
#### Contact Section

- On `.heading-sec__sub`, put a short description about the section.
- `.contact__form-field` is the field inside form. Currently, there are 3 fields but you can add more fields as per your need but just make sure to change the name of **label** and **input/textarea** inside it.
Expand Down Expand Up @@ -503,9 +501,7 @@ If you like to know how to submit forms so you can receive the form details in y
<!-- END Contact Section -->
```



### Footer Section
#### Footer Section

- Inside h4 tag with the class `heading heading-sm text-lt` add your name.
- On `.main-footer__short-desc` put a short description about yourself.
Expand Down Expand Up @@ -584,11 +580,11 @@ If you like to know how to submit forms so you can receive the form details in y

<br/>

## Step 3 - Project Page
### Step 3 - Project Page

Each project will have its own Page. The project page will have important details about the project like the Project Title, Description, Technologies, Project Links, etc.

### Project Hero Section
#### Project Hero Section

- On `.heading-primary` add the Project Title.
- On `.text-primary` add a short description about the Project.
Expand Down Expand Up @@ -616,7 +612,7 @@ Each project will have its own Page. The project page will have important detail

<!-- **** END Project Hero Section **** -->

### Project Details Section
#### Project Details Section

- On `.project-details__showcase-img`, change the value of **src** to the location/link of Project Mockup.
- On `.project-details__desc-para` to add a detailed paragraph describing your project. Use multiple `.project-details__desc-para` elements for multiple paragraphs.
Expand Down Expand Up @@ -702,10 +698,9 @@ Each project will have its own Page. The project page will have important detail

<br>


## Deployment 📦

Once you have done with your setup. You need to put your website online!
Once you have done with your setup, you need to put your website online!

I highly recommend to use [Netlify](https://netlify.com) to achieve this on the EASIEST WAY

Expand Down Expand Up @@ -748,7 +743,7 @@ If you find this project to be useful then please **support** me by donating som

## Give a Star ⭐

If you like this project then give it a **Github** star by pressing the **Star** button ⭐
If you like this project, give it a **GitHub** star by pressing the **Star** button ⭐

<br>

Expand All @@ -758,13 +753,13 @@ If you like this project then give it a **Github** star by pressing the **Star**

## Author 👨‍💻

- **Ram Maheshwari** - **[Linkedin](https://linkedin.com/in/rammcodes)**, **[Twitter](https://twitter.com/rammcodes)**, **[Github](https://github.com/rammcodes)**, **[Portfolio](https://rammaheshwari.com)**
- **Ram Maheshwari** - **[LinkedIn](https://linkedin.com/in/rammcodes)**, **[Twitter](https://twitter.com/rammcodes)**, **[GitHub](https://github.com/rammcodes)**, **[Portfolio](https://rammaheshwari.com)**

<br>

#### Note:
I'm currently looking for good **Job Opportunities** both **Remote ( Worldwide )** and **On-Site ( Anywhere in India )**. So, if you have a good opportunity that matches my skills experience then you can contact me on my **[Linkedin](https://linkedin.com/in/rammcodes)** or my email id **rammcodes@gmail.com** 🙌
### Note

I'm currently looking for good **Job Opportunities** both **Remote ( Worldwide )** and **On-Site ( Anywhere in India )**. So, if you have a good opportunity that matches my skills experience then you can contact me on my **[Linkedin](https://linkedin.com/in/rammcodes)** or my email id **rammcodes@gmail.com** 🙌

<br>

Expand All @@ -785,4 +780,3 @@ Special thanks to [Jacobo Martínez](https://github.com/cobidev) for inspiring m
## License 📄

This project is licensed under the **GPL-3.0** License - see the [LICENSE](LICENSE) file for details