A blueprint for producing professional project documentation — README.md, USER-GUIDE.md, and CONTRIBUTING.md. Use this as a checklist when documenting any open-source project.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ```powershell | |
| # host-check.ps1 | |
| Write-Host "=== PowerShell ===" | |
| $PSVersionTable | | |
| Select-Object PSVersion, PSEdition, OS, Platform | | |
| Format-List | |
| Write-Host "`n=== System ===" | |
| Get-CimInstance Win32_ComputerSystem | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| const esbuild = require("esbuild"); | |
| const path = require("path"); | |
| const fs = require("fs"); | |
| // Parse command line arguments | |
| const args = process.argv.slice(2).reduce((acc, arg) => { | |
| const [key, value] = arg.replace(/^--/, "").split("="); | |
| acc[key] = value; | |
| return acc; | |
| }, {}); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import { BrowserRouter, Route, Routes } from "react-router-dom"; | |
| import ProtectedRoute from "./auth/ProtectedRoute"; | |
| import Layout from "./layouts/Layout"; | |
| import Dashboard from "./pages/app/dashboard/Dashboard"; | |
| import Home from "./pages/app/home/Home"; | |
| import Login from "./pages/auth/login/Login"; | |
| function App() { | |
| const routes = [ | |
| { |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import React from "react"; | |
| import { useAppStore } from "./zustand-store"; | |
| const App = () => { | |
| const loading = useAppStore((state) => state.loading); | |
| const authUser = useAppStore((state) => state.authUser); | |
| const setAuthUser = useAppStore((state) => state.setAuthUser); | |
| const setLoading = useAppStore((state) => state.setLoading); | |
| const handleLogin = () => { |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <!-- This HTML demo merges audio from two physical microphones (if available) in the browser using the Web Audio API. It: | |
| ✅ Lists audio input devices | |
| ✅ Opens two getUserMedia streams | |
| ✅ Merges them with AudioChannelMergerNode | |
| ✅ Plays them back in real-time | |
| ✅ Records the mixed audio to a downloadable file (WebM) | |
| Test it locally in a secure context (HTTPS or localhost). |
NewerOlder