Skip to content

Commit

Permalink
Merge pull request #3 from awjans/patch-2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
dport96 committed May 16, 2024
2 parents f521f56 + 83e350d commit 1f0189f
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Professional Portfolio

For details on this professional portfolio, please see https://techfolios.github.io.
For details on this professional portfolio, please see [Techfolios](https://techfolios.github.io). Additional information can be found in the [documentation](https://techfolios.github.io/docs/overview), including [instructions](https://techfolios.github.io/docs/user-guide/cloud-development) on how to use [GitPod](https://www.gitpod.io/).

## [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/)
### [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/)

## [JSON Cheat Sheet](https://www.w3schools.com/js/js_json.asp)
### [JSON Cheat Sheet](https://www.w3schools.com/js/js_json.asp)

# Create your own NRTechfolio Repository

Expand All @@ -24,40 +24,42 @@ Find the green "Use this template" button in the top left of the screen. Click t

On the "Create a new repository" screen, fill in a name for your new repository in the middle of the page. It is suggested to use "NRTechfolio." Click the green "Create repository" button on the bottom right. Github will then create your new repository using the template and redirect you to the new repository when finished.

## Create a New Codespace

On the "<> Code" tab, find the green "<> Code" button. Click that button and select the "Codespaces" tab. Find and click the "Create codespace on main" button, and Github will a space for you to edit your repository without downloading software to your computer. The codespace will be a website named something like "https://tangerine-parakeet-w47p5rppp725xgx.github.dev/", which you can bookmark for fast access later. The README.md file containing these instructions will be previewed so you can continue to follow along.

# Setup Instructions

## Turn on Pages

* Go to [Settings/Pages](../../settings/pages) from your GitHub Repository, not the Codespace.
* Find the Branch section
* Choose the 'main' branch.
* Note the pages URL. It should be somegthing like `https://awjans.github.io/NRTechfolio/`
* Note the pages URL. It should be somegthing like `https://awjans.github.io/NRTechfolio/`. This is the URL to your published NRTechfolio and the value will be needed when editing the Config YAML file later.

## Create a New Codespace

On the "<> Code" tab, find the green "<> Code" button. Click that button and select the "Codespaces" tab. Find and click the "Create codespace on main" button, and Github will create a codespace for you to edit your repository without downloading software to your computer. The codespace will be a website named something like "https://tangerine-parakeet-w47p5rppp725xgx.github.dev/", which you can bookmark for fast access later. The README.md file containing these instructions will be previewed so you can continue to follow along.

# Setup Instructions

## Edit Config YAML

* Edit [_config.yml](_config.yml)
* Change 'Molly Maluhia' to your name on line 3
* Change 'dport96' to your GitHub username on line 5
* Change URL on line 5 to match the URL from the Pages configuration of your Repository.
* Change "/template" to "" on line 7

## Edit Biography JSON
## Edit [Biography JSON](https://techfolios.github.io/docs/quick-start/configure-bio-json)

* Edit [bio.json](_data/bio.json)
* Make the necessary changes so it reflects you
* Configure [bio.json](_data/bio.json)
* Make the necessary changes so it reflects you.

## Replace Essay Files
## Configure [Project Files](https://techfolios.github.io/docs/quick-start/configure-projects)

* In the [essays](essays) folder
* Rename/Edit or Replace the *.md files
* In the [projects](projects) folder
* Rename/Edit or Replace the *.md files. Save at least one as a template.

## Replace Project Files
## Configure [Essay Files](https://techfolios.github.io/docs/quick-start/configure-essays)

* In the [projects](projects) folder
* Rename/Edit or Replace the *.md files
* In the [essays](essays) folder
* Rename/Edit or Replace the *.md files. Save at least one as a template.

## Configure [Resume](https://techfolios.github.io/docs/quick-start/configure-resume)

## View and Post Portfolio

Expand Down

0 comments on commit 1f0189f

Please sign in to comment.