diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..24a3ba0 --- /dev/null +++ b/README.MD @@ -0,0 +1,66 @@ +# Manual Coffee Roasting Plan + +**Project Name:** Manual Coffee Roasting Plan +**Hosting:** [View on Gitea](https://your-gitea-instance.com/your-username/manual-coffee-roasting-plan) + +--- + +### Summary +A tool to track and visualize the manual coffee roasting process, including timer functionality and potential chart-based roasting curve tracking. + +--- + +### Installation +1. Clone the repository. +2. Install dependencies: + ```bash + npm install + # or + yarn install + ``` + +--- + +### Development Environment (VS Code) +1. Open the project in VS Code. +2. Ensure the following extensions are installed: + - **TypeScript** (for `.ts` file support) + - **Parcel** (for bundling) +3. Start the dev server: + ```bash + npm start + # or + yarn start + ``` + This will serve the app at `http://localhost:1234` (default Parcel port). + +--- + +### Deployment +Build the production-ready files: +```bash +npm run build +# or +yarn build +``` +The output will be in the `dist/` folder. Deploy this folder to any static hosting service (e.g., GitHub Pages, Netlify, or Gitea's built-in static hosting). + +--- + +### Technologies Used +- **TypeScript** (`src/roast.ts`) for type-safe logic. +- **Chart.js** and **chartjs-plugin-annotation** for potential roasting curve visualizations. +- **Parcel** for bundling and optimization. +- **PostCSS** and **Autoprefixer** for CSS compatibility. + +--- + +### Notes +- The core logic is in toast.ts +- The graph visual is in tempgraph.ts +- roast.html is the main web app, this is all static server content but the typescript may save some local information at your request on your system + +--- + +### Contributing +Pull requests are welcome! For major changes, please open an issue first. \ No newline at end of file