Skip to content

Commit 9e616ca

Browse files
committed
Cleaned up README
1 parent 3cbc12e commit 9e616ca

6 files changed

Lines changed: 39 additions & 8 deletions

File tree

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,31 @@ A community-maintained showcase of student capstone projects. The site is automa
88

99
## How to add your project
1010

11-
1. **Fork** this repository and create a new branch (e.g. `add/your-project-name`).
11+
1. **Fork** this repository using the Fork button on GitHub.
1212

13-
2. **Copy** `projects/_template.yml` to a new file in the same folder, named after yourself:
13+
2. **Clone your fork** locally or open it in a Codespace:
14+
```bash
15+
git clone https://github.com/your-username/2510-capstones.git
16+
```
17+
18+
3. **Copy** `projects/_template.yml` to a new file in the same folder, named after yourself:
1419
```
1520
projects/firstname-lastname-capstone.yml
1621
```
17-
Use lowercase letters and hyphens no spaces.
22+
Use lowercase letters and hyphens, no spaces.
1823

19-
3. **Fill in** your project details. Only `title` and `student` are required; everything else is optional but encouraged.
24+
4. **Fill in** your project details. Only `title` and `student` are required; everything else is optional but encouraged.
2025

21-
4. **Add images** (optional) to the repo root folders — name them after yourself with hyphens:
26+
5. **Add images** (optional) to the repo root folders, named after yourself with hyphens:
2227
```
2328
headshots/firstname-lastname-headshot.png
2429
screenshots/firstname-lastname-screenshot.png
2530
```
26-
The build script picks them up automatically no YAML changes needed.
31+
The build script picks them up automatically; no YAML changes needed.
2732

28-
5. **Open a pull request** back to `main`.
33+
6. **Open a pull request** from your fork back to `main` on this repo.
2934

30-
5. Once merged, your project appears on the live site within a minute or two.
35+
7. Once merged, your project appears on the live site within a minute or two.
3136

3237
### YAML fields
3338

docs/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<img src="/2510-capstones/assets/logo.png" alt="Fullstack Academy" height="36" />
1818
</a>
1919
<a class="site-title" href="/2510-capstones/">AI/ML Cohort 2510: Student Capstone Projects</a>
20+
<a class="site-link" href="https://www.fullstackacademy.com" target="_blank" rel="noopener noreferrer">fullstackacademy.com</a>
2021
</div>
2122
</header>
2223
<main>

docs/projects/budget-tracker/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<img src="/2510-capstones/assets/logo.png" alt="Fullstack Academy" height="36" />
1818
</a>
1919
<a class="site-title" href="/2510-capstones/">AI/ML Cohort 2510: Student Capstone Projects</a>
20+
<a class="site-link" href="https://www.fullstackacademy.com" target="_blank" rel="noopener noreferrer">fullstackacademy.com</a>
2021
</div>
2122
</header>
2223
<main>

docs/projects/recipe-finder-app/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<img src="/2510-capstones/assets/logo.png" alt="Fullstack Academy" height="36" />
1818
</a>
1919
<a class="site-title" href="/2510-capstones/">AI/ML Cohort 2510: Student Capstone Projects</a>
20+
<a class="site-link" href="https://www.fullstackacademy.com" target="_blank" rel="noopener noreferrer">fullstackacademy.com</a>
2021
</div>
2122
</header>
2223
<main>

docs/style.css

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,17 @@ header {
5151

5252
.site-title:hover { color: var(--red); }
5353

54+
.site-link {
55+
margin-left: auto;
56+
color: var(--muted);
57+
text-decoration: none;
58+
font-size: 0.85rem;
59+
font-weight: 500;
60+
white-space: nowrap;
61+
}
62+
63+
.site-link:hover { color: var(--red); }
64+
5465
main {
5566
flex: 1;
5667
max-width: 1100px;

scripts/build.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ function shell(title, bodyHtml) {
9999
<img src="/2510-capstones/assets/logo.png" alt="Fullstack Academy" height="36" />
100100
</a>
101101
<a class="site-title" href="/2510-capstones/">AI/ML Cohort 2510: Student Capstone Projects</a>
102+
<a class="site-link" href="https://www.fullstackacademy.com" target="_blank" rel="noopener noreferrer">fullstackacademy.com</a>
102103
</div>
103104
</header>
104105
<main>
@@ -260,6 +261,17 @@ header {
260261
261262
.site-title:hover { color: var(--red); }
262263
264+
.site-link {
265+
margin-left: auto;
266+
color: var(--muted);
267+
text-decoration: none;
268+
font-size: 0.85rem;
269+
font-weight: 500;
270+
white-space: nowrap;
271+
}
272+
273+
.site-link:hover { color: var(--red); }
274+
263275
main {
264276
flex: 1;
265277
max-width: 1100px;

0 commit comments

Comments
 (0)