Skip to content

Improve README Documentation #2

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.

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
39 changes: 34 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![GitHub repo size](https://img.shields.io/github/repo-size/codewithsadee/smith-portfolio)
![GitHub stars](https://img.shields.io/github/stars/codewithsadee/smith-portfolio?style=social)
![GitHub forks](https://img.shields.io/github/forks/codewithsadee/smith-portfolio?style=social)
[![Twitter Follow](https://img.shields.io/twitter/follow/codewithsadee_?style=social)](https://twitter.com/intent/follow?screen_name=codewithsadee_)
[![Twitter Follow](https://img.shields.io/twitter/follow/codewithsadee_?style=social)](https://twitter.com/intent/follow?screen_name=codewithsadee_)
[![YouTube Video Views](https://img.shields.io/youtube/views/BbCLWdF3Bnc?style=social)](https://youtu.be/BbCLWdF3Bnc)

<br />
Expand All @@ -27,23 +27,52 @@

Before you begin, ensure you have met the following requirements:

* [Git](https://git-scm.com/downloads "Download Git") must be installed on your operating system.
- [Git](https://git-scm.com/downloads "Download Git") must be installed on your operating system.
- [Ionicons](https://ionicons.com/) are used for icons.
- [Google Fonts](https://fonts.google.com/) are used for typography.

### Run Locally

To run **Smith-portfolio** locally, run this command on your git bash:
To run **Smith-portfolio** locally, follow these steps:

Linux and macOS:
1. Clone the repository:

Linux and macOS:
```bash
sudo git clone https://github.com/codewithsadee/smith-portfolio.git
```

Windows:

```bash
git clone https://github.com/codewithsadee/smith-portfolio.git
```
2. After cloning the repository, you can run a local development server using **live-server**:

Install live-server globally:
```bash
npm install -g live-server
```

Navigate to the project folder and run the server:
```bash
live-server
```

3. Open your browser and go to ```http://localhost:8080``` to see the portfolio.

### Customization

To customize this portfolio for your personal use, follow these instructions:

- **Images:** Replace the images in the **assets/images/** folder with your own. Ensure the filenames match or update the image paths in **index.html**.
- **Text Content:** Open the **index.html** file and replace the placeholder text (such as the hero section, portfolio details, and contact information) with your personal information.
- **Theme Colors:** You can modify the CSS custom properties in **assets/css/style.css** to update the colors used throughout the site.

### Usage Instructions

- The portfolio consists of various sections such as **Portfolio**, **Skills**, **Timeline**, **Pricing**, and **Contact**.
- You can navigate between these sections via the navigation menu or by scrolling down.
- To add new projects to the portfolio, simply update the **Portfolio** section in the **index.html** file with new images and titles.

### Contact

Expand Down