bartvdbraak/hellob.art
1
0
Fork 0
mirror of https://github.com/bartvdbraak/hellob.art.git synced 2025-04-26 17:11:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: update readme to reflect recent changes

Browse source
This commit is contained in:
Bart van der Braak 2024-01-23 01:27:54 +01:00
parent 4becb2bd49
commit 635ab5d374
1 changed files with 17 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -1,6 +1,6 @@
<div align="center"> <div align="center">
<a href="https://hellob.art/"><img src="https://github.com/bartvdbraak/hellob.art/assets/3996360/365337f4-0ad8-4107-bcb1-8a4843ceae94" alt="hellob.art" width="30%"></a> <a href="https://hellob.art/"><img src="https://github.com/bartvdbraak/hellob.art/assets/3996360/365337f4-0ad8-4107-bcb1-8a4843ceae94" alt="hellob.art" width="30%"></a>
<p><em>Personal website built with Svelte</em></p> <p><em>current work and studies in a SvelteKit-based portfolio</em></p>
</div> </div>
<div align="center"> <div align="center">
@ -9,6 +9,10 @@
<a href="https://github.com/bartvdbraak/hellob.art/deployments/activity_log?environment=Production"><img src="https://img.shields.io/github/deployments/bartvdbraak/hellob.art/production?label=vercel&logo=vercel" /></a> <a href="https://github.com/bartvdbraak/hellob.art/deployments/activity_log?environment=Production"><img src="https://img.shields.io/github/deployments/bartvdbraak/hellob.art/production?label=vercel&logo=vercel" /></a>
</div> </div>
## Description
This is a personal website built with Svelte and SvelteKit. It includes a variety of components and routes, and it's styled with Tailwind CSS. The project is set up with a number of quality assurance tools, including ESLint, Prettier, and Husky.
## Installation ## Installation
To install the project and its dependencies, follow these steps: To install the project and its dependencies, follow these steps:
@ -42,13 +46,18 @@ pnpm run dev
pnpm run dev -- --open pnpm run dev -- --open
``` ```
## Technologies Used ## Project Structure
- **Svelte:** The framework used for building this portfolio project. This project has the following structure:
- **SvelteKit:** The tooling and routing framework for Svelte projects.
- **Tailwind CSS:** A utility-first CSS framework packed with classes. - `src/`: This is where the main application code is stored. This includes:
- **Skeleton:** UI Toolkit for Svelte + Tailwind. - `app.d.ts`, `app.html`, `app.pcss`: Main application files.
- **Threlte:** Declarative Three.js for Svelte. - `lib/`: Contains assets, components, config, content, etc.
- `routes/`: Contains routing layout, pages and server-side code.
- `styles/`: Contains style files.
- `static/`: Contains static files like `browserconfig.xml`, `site.webmanifest`, and fonts.
- `.github/`: Contains GitHub related files like `dependabot.yml`, `renovate.json`, and workflows.
- Configuration files: `.eslintignore`, `.eslintrc.cjs`, `.gitignore`, `.npmrc`, `.prettierignore`, `.prettierrc`, `postcss.config.cjs`, `svelte.config.js`, `tailwind.config.js`, `tsconfig.json`, `vite.config.ts`.
## Contributing ## Contributing
@ -56,17 +65,4 @@ I'm open to contributions! If you find any bugs, have suggestions, or want to ad
## License ## License
This project is licensed under the GPLv3 License. Feel free to explore, learn, and have fun! This project is licensed under the terms of the [LICENSE](LICENSE) file.
Some dependencies may hold different licenses but are in compliance with GPLv3:
- `MIT`: Compatible with GPLv3.
- `Apache 2.0`: Compatible with GPLv3.
- `BSD-3-Clause`: Compatible with GPLv3.
- `BSD-2-Clause`: Compatible with GPLv3.
- `ISC`: Compatible with GPLv3.
- `Python-2.0`: Compatible with GPLv3. (Note: Python has its own license, and version 2.0 is compatible with GPLv3).
- `CC-BY-4.0`: This is a Creative Commons license, which is not a software license. It's generally not recommended to include CC licenses in software projects due to potential compatibility issues. This might cause complications if you choose GPLv3.
- `CC0-1.0`: Not a software license, but it is explicitly designed to waive all copyrights, making it effectively compatible with GPLv3.
- `0BSD`: Compatible with GPLv3.
- `(MIT OR CC0-1.0)`: MIT is compatible with GPLv3, and CC0-1.0 is effectively compatible with GPLv3.