From 7bf8b607169d5479d3c8c51f077b2615d38c0584 Mon Sep 17 00:00:00 2001 From: azur Date: Sat, 13 Dec 2025 17:29:36 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20Developement=20Setup=20ste?= =?UTF-8?q?ps.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d769117..81980a8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ -# Aconit +# 🥀 Aconit Aconit is an asymmetric horror game that is available on Roblox. The project is open source, so you can contribute to help develop it. -[![Discord](https://img.shields.io/discord/1352754862831439974?logo=discord)](https://discord.gg/QpAUUTJm3h) +[![Gitea Last Commit](https://img.shields.io/gitea/last-commit/revocation/aconit?gitea_url=https%3A%2F%2Fazur84.servehttp.com)]() [![Discord](https://img.shields.io/discord/1352754862831439974?logo=discord)](https://discord.gg/QpAUUTJm3h) [![Favorites](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgames.roblox.com%2Fv1%2Fgames%2F8513843510%2Ffavorites%2Fcount&query=%24.favoritesCount&label=%E2%AD%90%20Roblox%20Favorites&color=yellow)](roblox.com/games/76850012177914/Aconit) [![roblox-ts](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fazur84.servehttp.com%2FRevocation%2FAconit%2Fraw%2Fbranch%2Fmaster%2Fpnpm-lock.yaml&query=%24.importers%5B%22.%22%5D.devDependencies.roblox-ts.version&logo=roblox&label=roblox-ts&labelColor=ff0000&color=grey)](https://roblox-ts.com) [![flamework](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fazur84.servehttp.com%2FRevocation%2FAconit%2Fraw%2Fbranch%2Fmaster%2Fpnpm-lock.yaml&query=%24.importers%5B%22.%22%5D.dependencies%5B%22%40flamework%2Fcore%22%5D.version&label=flamework&labelColor=FF7139&color=grey)](https://flamework.fireboltofdeath.dev/) -## Develop Setup -TODO \ No newline at end of file +## 🪛 Developement Setup +I am describing this for people who have never used Node.js before. If you are already familiar with it, you may find it repetitive. +This project is based on roblox-ts and flamework. + +### 🪢 Node.js and pnpm +First of all you need to install [node.js](https://pnpm.io/) and [pnpm](https://pnpm.io/). +Node.js is used for building the project, and pnpm is the package manager. + +### 📦 Depencies installation +For install all depencies simply run ``pnpm install``. + +### 📝 Developement help +Don't hesitate to check [roblox-ts](https://roblox-ts.com) and [flamework](https://flamework.fireboltofdeath.dev/) docs or send a message on our [discord server](https://discord.gg/QpAUUTJm3h). + +### 🔨 Builds +Builds are automatic with gitea actions. \ No newline at end of file