📝 update README

This commit is contained in:
Sindre Kjelsrud 2023-12-10 01:39:57 +01:00
parent 6d03a117bd
commit 75ebcc0634

View file

@ -1,7 +1,5 @@
# CURRENTLY REWRITING WEBSITE TO ASTRO
<div align="center">
<img alt="logo" src="static/img/coolkid.png" width="100" />
<img alt="logo" src="/src/static/coolkid.png" width="100" />
</div>
<h1 align="center">
<a href="https://kjelsrud.dev">kjelsrud.dev</a>
@ -14,10 +12,10 @@
### What I've learned from the project so far
- Coding with html and css
- Coding with HTML, CSS, TypeScript, etc.
- Usage of SSG/frameworks like Hugo or Astro
- How to use Git
- Some understanding of Github Actions + Pages
- How to use some of the most popular open-source static site generators
- How to create websites that are faster, more secure, and easier to maintain
- How to use templates to generate static websites
- How to use DNS pointers (A- & CNAME records)
@ -26,27 +24,36 @@
### Features
...
- Blog
- Logs
### Future plans:
...
- [ ] CV
- [ ] Digital garden
- [ ] Uses
- [ ] Food wall
- [ ] Vinyl collection
## 🛠️ How do I run it locally?
1. Install the dependencies
`npm install or yarn`
1. Install the dependencies: `yarn`
2. Start the development server
`yarn dev`
## 🚀 Build and run for production
1. Generate a full static production build
`npm run build`
2. Start the development server: `yarn dev`
## 🎨 Color codes
...
| Color | Hex |
|-|-|
| Light bg | ![#FFF8EA](https://via.placeholder.com/10/FFF8EA?text=+) `#FFF8EA` |
| Coffee brown | ![#594545](https://via.placeholder.com/10/594545?text=+) `#594545` |
| Tan | ![#815B5B](https://via.placeholder.com/10/815B5B?text=+) `#815B5B` |
| Light tan | ![#9E7676](https://via.placeholder.com/10/9E7676?text=+) `#9E7676` |
| Sand | ![#DAC0A3](https://via.placeholder.com/10/DAC0A3?text=+) `#DAC0A3` |
| Catppuccin Base | ![#FFF8EA](https://via.placeholder.com/10/FFF8EA?text=+) `#FFF8EA` |
| Catppuccin Text | ![#cad3f5](https://via.placeholder.com/10/cad3f5?text=+) `#cad3f5` |
| Catppuccin Overlay0 | ![#6e738d](https://via.placeholder.com/10/6e738d?text=+) `#6e738d` |
| Catppuccin Surface0 | ![#363a4f](https://via.placeholder.com/10/363a4f?text=+) `#363a4f` |
| Catppuccin Crust | ![#181926](https://via.placeholder.com/10/181926?text=+) `#181926` |
## Versionlog
- I've put v1 in the branch called ...
- The first iteration of my website was a Hugo-instance that used a readymade theme called "PaperMod".