aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorValentin Popov <valentin@popov.link>2025-06-06 03:03:32 +0300
committerGitHub <noreply@github.com>2025-06-06 03:03:32 +0300
commit2f535ac598974740e7b9ac50a9351989f50112ea (patch)
treeb25c118f76986de6036556ec3fa86b6116bd577f
parentb1c85503d692eba7bc6fab5d10cb153e4da08a26 (diff)
downloadpopov.link-2f535ac598974740e7b9ac50a9351989f50112ea.tar.xz
popov.link-2f535ac598974740e7b9ac50a9351989f50112ea.zip
docs: update README and license
* docs: update README and add licenses * chore: remove unused materials license and update README for clarity
-rw-r--r--LICENSE.txt7
-rw-r--r--README.md53
2 files changed, 36 insertions, 24 deletions
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..7585607
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,7 @@
+Copyright (c) 2025 Valentin Popov <valentin@popov.link>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file
diff --git a/README.md b/README.md
index eec50d9..01fe69d 100644
--- a/README.md
+++ b/README.md
@@ -1,49 +1,54 @@
-# Personal site
+# popov.link
-This is my main site. The site publishes articles, useful information and notes. Also, the site serves as a hosting of free and personal images.
+[![CI](https://github.com/valentineus/popov.link/actions/workflows/ci.yml/badge.svg)](https://github.com/valentineus/popov.link/actions/workflows/ci.yml)
-Principles of site development:
+Personal website source code built with [Astro](https://astro.build/).
-- Lightness and minimalism. The site is designed to store information, it's not a heavy application;
+## Requirements
-- Maximum cross-platform. Information should be read from any device and software;
-
-- Focusing on content perception. Only useful information, nothing superfluous;
-
-- No JS on the site. The site should be completely safe for the user;
+- Node.js v22 or later
+- npm v11 or later
## Development
-To start a local server for development, you need:
-
-1. Clone the source repository:
+1. Install dependencies:
```bash
-git clone "https://github.com/valentineus/valentineus.github.io.git"
+npm ci
```
-2. Install packages:
+2. Start the development server:
```bash
-cd valentineus.github.io && bundle update
+npm run dev
```
-3. Start the server:
+3. Open your browser and go to http://localhost:3000 to view changes live.
+
+## Build & Preview
+
+- To build the project for production:
```bash
-bundle exec jekyll serve --host "${IP}" --port "${PORT}" --trace
+npm run build
```
-Please note in the executable command uses environment variables `IP` and `PORT`.
+- To preview the production build locally:
+
+```bash
+npm run preview
+```
-## License hosted material
+## Project Info
-<img width="256px" alt="CC BY-NC 3.0 License" src="https://raw.githubusercontent.com/valentineus/valentineus.github.io/master/assets/images/87624cb5-4a8f-4be4-90b6-0ec5b9a90333.png" />
+- Maintained by [Valentin Popov](mailto:valentin@popov.link)
+- Issues: [GitHub](https://github.com/valentineus/popov.link/issues)
+- Read-only mirror: [code.popov.link](https://code.popov.link/valentineus/popov.link)
-Material on the site is published on the CC BY-NC 3.0 license.
+## Comments
-## Source Code License
+Comments on the site are powered by [giscus.app](https://giscus.app) and stored in [GitHub Discussions](https://github.com/valentineus/popov.link/discussions).
-<img width="256px" alt="MIT License" src="https://raw.githubusercontent.com/valentineus/valentineus.github.io/master/assets/images/7d05cad0-d553-42c7-be1f-7007926ba720.png" />
+## License
-[MIT](LICENSE.txt). Copyright (c) [Valentin Popov](https://valentineus.link/).
+This project is licensed under the [MIT License](LICENSE.txt). \ No newline at end of file