Commit 7729b23

HPCesia <me@hpcesia.com>
2026-02-15 09:08:10
Add License and README documents
1 parent 8d72a7e
Changed files (2)
LICENSE
@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, HPCesia
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
README.md
@@ -1,43 +1,21 @@
-# Astro Starter Kit: Minimal
+# Tybios
 
-```sh
-pnpm create astro@latest -- --template minimal
-```
+> [!WARNING]
+> This project is still in a very early stage of development, lacks basic functionalities.
 
-> ๐Ÿง‘โ€๐Ÿš€ **Seasoned astronaut?** Delete this file. Have fun!
+A Tufted style blog template powered by Astro and Typst.
 
-## ๐Ÿš€ Project Structure
+## Features
 
-Inside of your Astro project, you'll see the following folders and files:
+> [!NOTE]
+> WIP
 
-```text
-/
-โ”œโ”€โ”€ public/
-โ”œโ”€โ”€ src/
-โ”‚   โ””โ”€โ”€ pages/
-โ”‚       โ””โ”€โ”€ index.astro
-โ””โ”€โ”€ package.json
-```
+## Acknowledgements
 
-Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
+This project could not have been realized without [astro-typst](https://github.com/OverflowCat/astro-typst) and [typst.ts](https://github.com/Myriad-Dreamin/typst.ts).
 
-There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
+This project draws inspiration from [Tufted CSS](https://github.com/edwardtufte/tufte-css) and [tufted](https://github.com/vsheg/tufted).
 
-Any static assets, like images, can be placed in the `public/` directory.
+## License
 
-## ๐Ÿงž Commands
-
-All commands are run from the root of the project, from a terminal:
-
-| Command                   | Action                                           |
-| :------------------------ | :----------------------------------------------- |
-| `pnpm install`             | Installs dependencies                            |
-| `pnpm dev`             | Starts local dev server at `localhost:4321`      |
-| `pnpm build`           | Build your production site to `./dist/`          |
-| `pnpm preview`         | Preview your build locally, before deploying     |
-| `pnpm astro ...`       | Run CLI commands like `astro add`, `astro check` |
-| `pnpm astro -- --help` | Get help using the Astro CLI                     |
-
-## ๐Ÿ‘€ Want to learn more?
-
-Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
+[BSD-3-Clause](./LICENSE).