This commit is contained in:
22
README.md
22
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.
|
Aconit is an asymmetric horror game that is available on Roblox. The project is open source, so you can contribute to help develop it.
|
||||||
|
|
||||||
[](https://discord.gg/QpAUUTJm3h)
|
[]() [](https://discord.gg/QpAUUTJm3h) [](roblox.com/games/76850012177914/Aconit) [](https://roblox-ts.com) [](https://flamework.fireboltofdeath.dev/)
|
||||||
|
|
||||||
## Develop Setup
|
## 🪛 Developement Setup
|
||||||
TODO
|
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.
|
||||||
Reference in New Issue
Block a user