From 8974d9bd80529470e774b54b3cacbac2d325cfc5 Mon Sep 17 00:00:00 2001 From: Blaquewithaq Date: Mon, 16 Jun 2025 16:55:45 -0500 Subject: [PATCH] chore: updated README --- README.md | 40 ++++++++++++----------- content/1.docs/3.contribute.md | 60 ++++++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+), 19 deletions(-) create mode 100644 content/1.docs/3.contribute.md diff --git a/README.md b/README.md index ceccda6..1f47ac2 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,48 @@ -# ProjectM Visualizer Organization Website +# ProjectM Visualizer — Official Website -This is the official website for the Projectm Visualizer organization, which hosts various visualizer projects and resources. +[🔗 Visit the Website](https://projectm-visualizer.org) -## Development +Welcome to the official website of the **ProjectM Visualizer** organization. This site serves as a central hub for our visualizer-related projects, resources, and community updates. -To set up the development environment, follow these steps: +--- -1. Clone the repository: +## 🛠 Development Setup + +Follow these steps to get the site running locally: + +### 1. Clone the Repository ```bash git clone https://github.com/projectM-visualizer/projectm-visualizer.org +cd projectm-visualizer.org ``` -2. Install bun.sh +### 2. Install bun.sh +#### Linux / macOS ```bash -# Linux / macOS curl -fsSL https://bun.sh/install | bash ``` +#### Windows ```powershell -# Windows powershell -c "irm bun.sh/install.ps1 | iex" ``` -3. Install dependencies: +### 3. Install dependencies: ```bash bun install ``` -4. Start the development server: +### 4. Start the development server: ```bash bun dev ``` -5. Open your browser and navigate to `http://localhost:3000` to view the website. +### 5. Open your browser and navigate to [http://localhost:3000](http://localhost:3000) to view the website.
-## Screenshots +## ⚠️ Known Issues -
- -
+- `bun install` may fail on Windows due to missing `node-gyp`. This is caused by `better-sqlite3`. + - To fix this, you can run `npm install` followed by `bun install` to install the dependencies. + - This will then allow you to utilize the environment without issues. + - Linux has no issues with this. diff --git a/content/1.docs/3.contribute.md b/content/1.docs/3.contribute.md new file mode 100644 index 0000000..7777b28 --- /dev/null +++ b/content/1.docs/3.contribute.md @@ -0,0 +1,60 @@ +--- +title: Contribute +description: Learn how to contribute to our project. +--- + +# 🙌 Contributing to the Documentation + +Thank you for your interest in contributing! Our documentation is powered by [Nuxt Content](https://content.nuxt.com/), which allows you to write Markdown files with Vue components, frontmatter, and powerful features built in. + +Whether you're fixing a typo, improving explanations, or adding entirely new pages — your help is appreciated! + +--- + +## 🗂 Where to Find the Docs + +All documentation lives in the `content/1.docs` directory of this repository: +``` +project-root/ +├── content/ +│ ├── 1.docs/ +│ │ ├── 1.user/ +│ │ ├── 2.developer/ +│ │ ├── contribute.md ← you're here! +│ │ └── ... +``` +Each Markdown file represents a page in the site. + +--- + +## 🛠 How to Make Changes + +1. Fork the repository and clone it locally. +2. Install dependencies, if you haven't already: +```bash +bun install +``` +3. Start the development server: +```bash +bun dev +``` +4. Navigate to `http://localhost:3000` and preview your changes in real-time. +5. Make your edits inside the appropriate `.md` file in the `content/1.docs` directory. + +# ✍️ Writing Style & Guidelines + +- Use clear and concise language. +- Prefer short paragraphs and bullet points where appropriate. +- Use semantic Markdown (##, -, **bold**, etc.). +- Add frontmatter (title, description) to each page. +- You can embed components if needed. Example: +``` +::u-button +--- +class: mr-4 +icon: i-simple-icons-stackblitz +label: Play on StackBlitz +target: _blank +to: https://stackblitz.com/github/projectm-visualizer/projectm-visualizer.org +--- +```