Imbus/FrostByte
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Testing some readme formatting

Browse source
This commit is contained in:
Imbus 2023-10-20 23:36:08 +02:00
parent 0ea21cfaf3
commit 305aa5fd1d
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -7,14 +7,22 @@ A simple forum written in Rust and Typescript.
## Structure ## Structure
- `server`: Contains the web server code - `server`: Contains the web server code
- `client`: Contains the frontend client - `client-solid`: Contains the frontend client written in SolidJS
- `client-solid`: Contains the frontend client written in SolidJS (WIP)
## Setup ## Setup
- Install [Rust](https://www.rust-lang.org/) and [Node.js](https://nodejs.org/) - Install [Rust](https://www.rust-lang.org/) and [Node.js](https://nodejs.org/)
- Install [Just](https://just.systems/man/en/) and [Podman](https://podman.io/) (optional but recommended) - Install [Just](https://just.systems/man/en/) and [Podman](https://podman.io/) (optional but recommended)
> [!NOTE]
> Some info
> [!IMPORTANT]
> Some important info
> [!WARNING]
> Some very important info
## Running the project ## Running the project
There are two ways to run this project. The simple way and the manual way. There are two ways to run this project. The simple way and the manual way.