Skip to content

Commit 223faf9

Browse files
Update README.md - Formatting changes (#201)
* Update README.md Minor formatting changes * Update README.md Co-authored-by: Ashutosh Hathidara <ashutoshhathidara98@gmail.com>
1 parent 6d333be commit 223faf9

1 file changed

Lines changed: 23 additions & 25 deletions

File tree

README.md

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
</p>
44

55
<h1 align="center"> Software Developer Master Portfolio 🔥 </h1>
6-
<h3 align="center"> A clean, beautiful, responsive and 100% customizable portfolio <br /> template for Software Developers! </h3>
6+
<h3 align="center"> A clean, beautiful, responsive, and 100% customizable portfolio <br /> template for Software Developers! </h3>
77

88
<p align="center">
99
<a href="http://hits.dwyl.com/ashutosh1919/masterPortfolio"><img alt="HitCounts" src="http://hits.dwyl.com/ashutosh1919/masterPortfolio.svg" /></a>
@@ -21,7 +21,7 @@
2121
<a href="https://ashutoshhathidara.com/"><img alt="License" src="http://img.shields.io/:license-mit-blue.svg?style=flat-square?style=flat-square" /></a>
2222
<a href="https://img.shields.io/badge/price-free-ff69b4"><img alt="Price" src="https://img.shields.io/badge/price-free-ff69b4?style=flat-square" /></a>
2323
</p>
24-
<p align="center">If you want to discuss about something, then you can ask on my <a href="https://discord.com/invite/GkcbM5bwZr">Discord Server</a>.</p>
24+
<p align="center">If you want to discuss about something, you can ask on my <a href="https://discord.com/invite/GkcbM5bwZr">Discord Server</a>.</p>
2525

2626
<p align="center">
2727
<a href="https://ashutosh1919.github.io" target="_blank">
@@ -44,21 +44,21 @@
4444

4545
To view a live example, **[click here](https://ashutosh1919.github.io/)**
4646

47-
# Clone And Use 📋
47+
# Clone and Use 📋
4848

49-
- The website is completely built on `react-js` library of `javascript` and that's why we need `nodejs` and `npm` installed.
50-
- While installing `nodejs` and `npm`, try to install versions which are equal or greater than the versions mentioned in badges above.
51-
- In case you want to help developing it or simply saving it, you can fork the repository just by clicking the button on the top-right corner of this page.
49+
- The website is completely built on `react-js` library of `javascript` and that's why we need `nodejs` and `npm` installed
50+
- While installing `nodejs` and `npm`, try to install versions which are equal or greater than the versions mentioned in badges above
51+
- In case you want to help developing it or simply saving it, you can fork the repository just by clicking the button on the top-right corner of this page
5252
- After the successful installation of `nodejs` and `npm`, clone the repository into your local system using below command:
53-
- ```bash
53+
```bash
5454
git clone https://github.com/ashutosh1919/masterPortfolio.git
5555
```
56-
- This will clone the whole repository in your system.
56+
This will clone the whole repository in your system.
5757
- To download required dependencies to your system, navigate to the directory where the cloned repository resides and execute following command:
58-
- ```node
58+
```node
5959
npm install
6060
```
61-
- Now, the project is ready to use.
61+
- Now the project is ready to use
6262
- You can check it using `npm start`, it will open the website locally on your browser.
6363

6464
# Customize it to make your own portfolio ✏️
@@ -126,38 +126,35 @@ Whenever you want to update the github related information on the website you ne
126126
Note here that if you click [my portfolio](https://ashutosh1919.github.io), you can see animating the logo at the beginning. I have designed that logo in [`Figma`](https://www.figma.com/) and then animated it using css.
127127
Therefore, this part of portfolio is not customizable. But don't worry we have a solution to this problem. You have below two alternatives:
128128

129-
- If you want to design your own logo, then you can design it using `Figma` or `Adobe XD` or `Adobe Illustrator` or `Inkscape`. If you want to animate it, you can refer to `./src/components/Loader` directory which contains `js` and `css` files which animates the logo.
130-
- If you don't want Splash screen or you don't know how to design logo, then this option is for you.
129+
- If you want to design your own logo, then you can design it using `Figma` or `Adobe XD` or `Adobe Illustrator` or `Inkscape`. If you want to animate it, you can refer to `./src/components/Loader` directory which contains `js` and `css` files which animates the logo
130+
- If you don't want Splash screen or you don't know how to design logo, then this option is for you
131131

132132
- You can open `src/portfolio.js` file and at the top of this file you will see `settings` component as below:
133-
- ```javascript
133+
```javascript
134134
// Website related settings
135135
const settings = {
136136
isSplash: true,
137137
};
138138
```
139-
- Change `isSplash` from `true` to `false`.
140-
- Now, if you see your website using `npm start`, it will directly open `home` rather than animating logo `splash` screen.
139+
- Change `isSplash` from `true` to `false`
140+
- Now, if you see your website using `npm start`, it will directly open `home` rather than animating logo `splash` screen
141141
- If you design your logo in future, then edit the files in `./src/components/Loader` and then revert `isSplash` to `true` in `src/portfolio.js`.
142142

143143
## Other
144144

145145
- You need to change the website title and other descriptions in `public/index.html`
146-
147146
- You can define your own favicon in `public/icons` directory. If you don't have a favicon, you can generate favicons from [Favicon Generator](https://www.favicon-generator.org/) and [Favicon IO](https://favicon.io/)
148-
149-
- Also you can edit your website preview known as description image. Run your site locally, take a screenshot and replace with `public/icons/desc.png`. Note that your screenshot should be 1280x640 for better preview
147+
- You can also edit your website preview (known as description image). Run your site locally, take a screenshot and replace with `public/icons/desc.png`. Note that your screenshot should be 1280x640 for better preview.
150148
151149
# Choose Theme 🌈
152150
153-
- You can take a look at `src/theme.js` file where all available themes are mentioned with their respective color codes.
151+
- You can take a look at `src/theme.js` file where all available themes are mentioned with their respective color codes
154152
- At the bottom of this file you will see the below code:
155153
- `export const chosenTheme = blueTheme;`
156-
- You need to change the name from `blueTheme` to whatever theme you want to set your website to.
157-
- You can define new theme similarly as other themes and you can assign name of that new defined theme to `chosenTheme`.
158-
- That's it. You just need to change the theme name and the code will take care of everything else.
159-
160-
Run `npm start` to check if everything is ok.
154+
- You need to change the name from `blueTheme` to whatever theme you want to set your website to
155+
- You can define new theme similarly as other themes and you can assign name of that new defined theme to `chosenTheme`
156+
- That's it. You just need to change the theme name and the code will take care of everything else
157+
- Run `npm start` to check if everything is ok.
161158

162159
# Deployment 📦
163160

@@ -171,7 +168,8 @@ Therefore, this part of portfolio is not customizable. But don't worry we have a
171168
- Run `npm run build` to generate the production build folder.
172169
- Enter the build folder, `git init` and push the generated code to the `master` branch of your new repository on github. That's it. It's Done.
173170
- You may need to `git init` and force push at every new build.
174-
**Option 2 (will not work with [user pages](https://docs.github.com/en/github/working-with-github-pages/about-github-pages)):**
171+
172+
**Option 2 (will not work with [user pages](https://docs.github.com/en/github/working-with-github-pages/about-github-pages)):**
175173
176174
- Run `npm run deploy` to build and create a branch called `gh-pages`. It will push the `build` files to that branch.
177175
- The last step in deploying is to enable `Github Pages` in settings of the repository and select `gh-pages` branch.

0 commit comments

Comments
 (0)