feat: Adding README (#39)

* Adding readme

* academic papers

LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2023- Melek Somai. (https://somai.me)
+
+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.

README.md

@@ -1,77 +1,69 @@
-# Melek Somai personal website
+# Melek Somai Personal Website
 
-This is an official starter turborepo.
+Welcome to the GitHub repository for my personal website [somai.me](https://somai.me)! I created this site to serve as a portfolio showcasing my projects, research publications, and experiences. It is also a playground to learn about web frameworks like [next.js](https://nextjs.org/), and other web tools.
 
-## What's inside?
+## Technologies Used
 
-This turborepo uses [pnpm](https://pnpm.io) as a packages manager. It includes the following packages/apps:
+- [Next.js 13](https://nextjs.org/) with App Router: One of the most popular React frameworks.
+- [Vanilla Extract](https://vanilla-extract.style/): A zero-runtime stylesheets in Typescript. It is compatible with React Server Components (RSC) and it replaces [Stitches](https://stitches.dev/) my previous choice of CSS-in-JSS.
+- [ESlint](https://eslint.org/) and Prettier: For clean, consistent, and error-free code.
+- [Radix UI](https://www.radix-ui.com/): It is one of the most beautiful headless UI components library.
+- [pnpm](https://pnpm.io/): Fast, disk space efficient package manager.
+- [Turborepo](https://turbo.build/): Incremental bundler and build system optimized for JavaScript and TypeScript, written in Rust.
+- [Markdoc](https://markdoc.dev/): Powerful, flexible, Markdown-based authoring framework open sourced by Stripe team.
+- [What I listed to in Spotify](): Inspired by and copied from [leerob.io](https://github.com/leerob/leerob.io).
+- [Vercel](https://vercel.com/): For hosting and deployment.
+- [Citation JS](https://citation.js.org/): a format-independent, modular bibliography tool to manage my academic publications.
 
-### Apps and Packages
+## Getting Started
 
-- `docs`: a [Next.js](https://nextjs.org) app
-- `web`: another [Next.js](https://nextjs.org) app
-- `ui`: a stub React component library shared by both `web` and `docs` applications
-- `eslint-config-thugga`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
-- `tsconfig`: `tsconfig.json`s used throughout the monorepo
+If you're interested in running this project locally, follow the steps below:
 
-Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
+### Prerequisites
 
-### Utilities
+Make sure you have the following software installed on your system:
 
-This turborepo has some additional tools already setup for you:
+- Node.js >= 16.x
+- Git
 
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
+### Installation
 
-## Setup
+1. First, clone the repository to your local machine:
 
-This repository is used in the `npx create-turbo@latest` command, and selected when choosing which package manager you wish to use with your monorepo (pnpm).
-
-### Build
+```bash
+git clone https://github.com/meleksomai/website.git
+```
 
-To build all apps and packages, run the following command:
+2. Move into the project directory:
 
-```
-cd my-turborepo
-pnpm run build
+```bash
+cd website
 ```
 
-### Develop
+3. Install the project dependencies:
 
-To develop all apps and packages, run the following command:
-
-```
-cd my-turborepo
-pnpm run dev
+```bash
+pnpm i
 ```
 
-### Remote Caching
+4. Start the development server:
 
-Turborepo can use a technique known as [Remote Caching](https://turborepo.org/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
+```bash
+pnpm dev
+```
 
-By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
+Now the project should be up and running at `http://localhost:3000`!
 
-```
-cd my-turborepo
-pnpx turbo login
-```
+## Contributing
 
-This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
+While this is primarily a personal project, contributions or suggestions are always welcome. If you have any ideas for improvements or have noticed any bugs, please open an issue.
 
-Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
+## License
 
-```
-pnpx turbo link
-```
+This project is open source and available under the [MIT License](LICENSE).
 
-## Useful Links
+## Acknowledgements
 
-Learn more about the power of Turborepo:
+I'd like to thank everyone who has inspired, supported, and helped me throughout my journey. Your encouragement and guidance have been invaluable.
 
-- [Pipelines](https://turborepo.org/docs/core-concepts/pipelines)
-- [Caching](https://turborepo.org/docs/core-concepts/caching)
-- [Remote Caching](https://turborepo.org/docs/core-concepts/remote-caching)
-- [Scoped Tasks](https://turborepo.org/docs/core-concepts/scopes)
-- [Configuration Options](https://turborepo.org/docs/reference/configuration)
-- [CLI Usage](https://turborepo.org/docs/reference/command-line-reference)
+Happy Coding! 🚀