Skip to content

Commit 150fde1

Browse files
committed
Update README
1 parent 4d958d3 commit 150fde1

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

README.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Toska
1+
# Toska.dev
2+
3+
<img height=100 src="public/assets/toska-logo.svg" />
24

35
[https://toska.dev](https://toska.dev)
46

@@ -9,14 +11,14 @@
911

1012
## Adding content
1113

12-
Content from the site comes from the files in the `content` folder. `.md` files support Markdown syntax as you might be able to guess but notice in order to use other elements than basic bolding and italicized further setup is needed.
13-
14-
### Adding a new projects
14+
Content from the site comes from the files in the `src/content` folder. Write project descriptions etc. in the Markdown files (`.md`).
1515

16-
1. Make a new .md file to the `content/projects` folder.
16+
### Projects
1717

18-
- Name of the file is meaningful (decides the URL)
18+
To add a new project, follow these instructions.
1919

20+
1. Make a new .md file to the `src/content/projects` folder.
21+
- Name of the file should be meaningful as it decides the URL
2022
2. On the top of the .md file add metadata like so:
2123

2224
```
@@ -32,23 +34,27 @@ title: project's name
3234
date: Project starting month - Project ending month (if any) e.g. Helmikuu 2020 - Kesäkuu 2021
3335

3436
3. Add the actual content describing the project
37+
- First paragraph is what is shown as preview on the front page
38+
4. Add an image of the project to `public/projects/` in .png format using the same name as the .md made in step 1.
39+
5. Add the name of the project in [project.ts](./src/types/project.ts) and export its image in [PreviewImage.tsx](./src/components/Projects/ProjectCard/PreviewImage.tsx)
40+
- This is done so that the image load immediately when the page is loaded
3541

36-
- First paragraph is what is shown as preview on the front page.
42+
### Members
3743

38-
4. Add an image (square aspect ratio - recommended approximately 1000x1000) of the project to `public/projects/` in .png format using the same name as the .md made in step 1.
44+
To add new members or edit exit dates etc., see [members.json](./src/content/members.json).
3945

40-
### intro.md
46+
Please append new members at the end of the file as it is used to generate the member number!
4147

42-
Text on top below the logo and "Helsingin yliopiston tietojenkäsittelytieteen osaston sovelluskehitysakatemia".
48+
Structure of `members.json`. See also the [Member](./src/types/member.ts) type.
4349

44-
### members.json
50+
| Property | Type | Description |
51+
| ------------ | ------------------------------ | -------------------------------------------------- |
52+
| name | string | First name |
53+
| gitHubName | string | GitHub username, also used for fetching the avatar |
54+
| linkedInName | string? | LinkedIn username, see linkedin.com/id/{username} |
55+
| joinDate | {month: number, year: number} | Month and year of when joined Toska |
56+
| exitDate | {month: number, year: number}? | Month and year of when left Toska if applicable |
4557

46-
_Note the order in the array is meaningful_
58+
### Deploying
4759

48-
| Property | Type | Description |
49-
| ------------ | ------------------------------ | ---------------------------------------------------------------- |
50-
| name | string | First name of the members. |
51-
| gitHubName | string | GitHub user of the member. Also used for fetching the avatar. |
52-
| linkedInName | string | LinkedIn user of the member. |
53-
| joinDate | {month: number, year: number} | Month and year of when the member joined. |
54-
| exitDate | {month: number, year: number}? | Month and year of when the member became an alumn if applicable. |
60+
Pushing to `master` runs CI and pushes to production.

0 commit comments

Comments
 (0)