docs: more comprehensive documentation

This commit is contained in:
SethBurkart123
2025-06-29 09:44:39 +10:00
parent db92af7405
commit 26613beb02
7 changed files with 1261 additions and 49 deletions
+32 -44
View File
@@ -56,58 +56,46 @@ If you are looking to create custom themes, I would recommend you start at the o
Don't worry- if you get stuck feel free to ask around in the [discord](https://discord.gg/YzmbnCDkat). We're open and happy to help out! Happy creating :)
## Getting started
## 🚀 Want to Contribute?
    **1. Clone the repository**
**New contributors welcome!** 🎉 We've made it easy to get started:
```
git clone https://github.com/BetterSEQTA/BetterSEQTA-Plus
- **👋 New to the project?** Start with our [Getting Started Guide](./docs/GETTING_STARTED_CONTRIBUTING.md)
- **🏗️ Want to understand the code?** Check out our [Architecture Guide](./docs/ARCHITECTURE.md)
- **🧩 Interested in plugins?** Read our [Plugin Development Guide](./docs/plugins/README.md)
- **🐛 Found a bug?** Open an [issue](https://github.com/BetterSEQTA/BetterSEQTA-plus/issues) or fix it yourself!
- **💬 Need help?** Join our [Discord community](https://discord.gg/YzmbnCDkat)
We have lots of [`good first issue`](https://github.com/BetterSEQTA/BetterSEQTA-plus/labels/good%20first%20issue) labels perfect for beginners!
## Quick Development Setup
    **1. Fork & Clone**
```bash
git clone https://github.com/YOUR_USERNAME/BetterSEQTA-Plus
cd BetterSEQTA-Plus
```
    **2. Install dependencies**
You may install the dependencies like below:
```
npm install # or your preferred package manager like pnpm or yarn
    **2. Install & Run**
```bash
npm install --legacy-peer-deps
npm run dev
```
But it is recommended to do it like this:
    **3. Load in Browser**
1. Go to `chrome://extensions`
2. Enable "Developer mode"
3. Click "Load unpacked" → Select `dist` folder
4. Visit a SEQTA page to see it work! 🎉
📚 **Need more details?** Check our [detailed setup guide](./docs/GETTING_STARTED_CONTRIBUTING.md#your-first-30-minutes)
### Building for Production
```bash
npm run build # Build for all browsers
npm run zip # Package for distribution (requires 7-Zip)
```
npm install --legacy-peer-deps # Only NPM supported
```
### Running Development
    **3. Run the dev script (it updates as you save files)**
```
npm run dev # or use your preferred package manager
```
### Building for production
    **4. Run the build script**
```
npm run build # or use your preferred package manager
```
    **4.1. Package it up (optional)**
```
npm run zip # This REQUIRES 7-Zip to be installed in order to work. You can also use your preferred package manager
```
    **5. Load the extension into chrome**
- Go to `chrome://extensions`
- Enable developer mode
- Click `Load unpacked`
- Select the `dist` folder
Just remember, in order to update changes to the extension if you are running in developer mode, you need to click the refresh button on the extension in `chrome://extensions` whenever anything's changed.
## Folder Structure