Skip to content

Commit fa64da4

Browse files
author
theispitar
committed
added readme files
1 parent 4546817 commit fa64da4

5 files changed

Lines changed: 57 additions & 34 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
# theispitar.github.io
2-
My personal website, hosted on GitHub Pages with a custom domain.
2+
Personal website for theispitar, hosted on GitHub Pages with a custom domain.
33

4-
## Structure
5-
- `index.html`: Home page.
6-
- `assets/css/main.css`: Shared site styles.
7-
- `assets/img/`: Shared images (favicon, etc.).
8-
- `projects/`: Project pages, each in its own folder.
9-
- `404.html`: Custom not found page for GitHub Pages.
4+
## Live site
5+
- https://theispitar.com
106

11-
## Local preview
12-
Open `index.html` directly in a browser or use a static server of your choice.
7+
## What this is
8+
A personal portfolio site that highlights selected projects, experiments, and one-off pages.
9+
It is intentionally lightweight and static, with a focus on presentation.
10+
11+
## Site map
12+
- `index.html`: landing page and featured projects.
13+
- `projects/`: project pages and the projects index.
14+
- `assets/`: shared styles and site-wide assets.
15+
- `404.html`: custom 404 page.
16+
17+
## Featured work
18+
- Wrapped: a personal listening dashboard.
19+
- Family Christmas Charity Tracker: a small, archived utility page.
20+
21+
## More context
22+
- `projects/README.md`: project list and short context.
23+
- `projects/wrapped/README.md`: background on the Wrapped dashboard.
24+
- `projects/family-christmas-charity-tracker/README.md`: background on the archived page.

‎assets/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Assets
2+
Shared assets used across the portfolio site.
3+
4+
## What lives here
5+
- `css/`: global styles and tokens.
6+
- `img/`: site-wide images like the favicon.

‎projects/README.md‎

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,11 @@
11
# Projects
2-
Each project lives in its own folder under `projects/`.
2+
Project pages live under `projects/`. This section of the site collects experiments,
3+
tools, and one-off builds that do not need a full standalone product surface.
34

4-
## New project checklist
5-
1. Create a new folder: `projects/<slug>/`.
6-
2. Add an `index.html` entry point.
7-
3. Add a short description to `projects/index.html`.
8-
4. Link it from the home page (`index.html`).
5+
## Highlights
6+
- `wrapped/`: a personal listening dashboard built from last.fm history.
7+
- `family-christmas-charity-tracker/`: a small, archived utility page.
98

10-
## Minimal HTML template
11-
```html
12-
<!doctype html>
13-
<html lang="en">
14-
<head>
15-
<meta charset="utf-8">
16-
<meta name="viewport" content="width=device-width, initial-scale=1">
17-
<title>Project Name | theispitar</title>
18-
<link rel="stylesheet" href="/assets/css/main.css">
19-
</head>
20-
<body>
21-
<main class="main-container">
22-
<h1 class="section-title">Project Name</h1>
23-
<p class="tagline">Short description.</p>
24-
<p><a class="project-link" href="/">Back to home</a></p>
25-
</main>
26-
</body>
27-
</html>
28-
```
9+
## Structure
10+
- `index.html`: project list page.
11+
- Each project lives in its own folder and owns its assets.

‎projects/family-christmas-charity-tracker/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Family Christmas Charity Tracker (archived)
2+
An archived, single-page table that collected charity donation links and amounts
3+
for a family holiday drive.
4+
5+
## What it shows
6+
- A compact table layout with a warm, seasonal tone.
7+
- A minimal, focused page design built for quick sharing.

‎projects/wrapped/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Wrapped
2+
A personal "Last.fm Wrapped" dashboard that visualizes listening history over time.
3+
It is designed as a single-page, data-rich snapshot of yearly listening trends.
4+
5+
## What it showcases
6+
- A dense, dashboard-style layout with custom charts and typography.
7+
- Year-over-year comparisons and discovery metrics.
8+
- Locally cached artwork to keep the experience self-contained.
9+
10+
## Inside the project
11+
- `index.html`: layout and structure.
12+
- `styles.css`: visual system and theming.
13+
- `app.js`: data processing and rendering.
14+
- `data/wrapped/`: yearly listening summaries.
15+
- `artwork/` and `artwork_manifest.json`: cached cover art.

0 commit comments

Comments
 (0)