From a50134270054790190871abf6414a79428223cd8 Mon Sep 17 00:00:00 2001
From: Dustella <fdnoaivj@outlook.com>
Date: Sat, 8 Feb 2025 21:43:26 +0800
Subject: [PATCH] docs: update readme

---
 env-linux.yml | 45 +++++++++++++++++++++++++++++++++++++++++++++
 readme.md     | 44 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 89 insertions(+)
 create mode 100644 env-linux.yml
 create mode 100644 readme.md

diff --git a/env-linux.yml b/env-linux.yml
new file mode 100644
index 0000000..e7443a4
--- /dev/null
+++ b/env-linux.yml
@@ -0,0 +1,45 @@
+name: vertex
+channels:
+  - defaults
+  - https://repo.anaconda.com/pkgs/main
+  - https://repo.anaconda.com/pkgs/r
+dependencies:
+  - _libgcc_mutex=0.1=main
+  - _openmp_mutex=5.1=1_gnu
+  - bzip2=1.0.8=h5eee18b_6
+  - ca-certificates=2024.12.31=h06a4308_0
+  - ld_impl_linux-64=2.40=h12ee557_0
+  - libffi=3.4.4=h6a678d5_1
+  - libgcc-ng=11.2.0=h1234567_1
+  - libgomp=11.2.0=h1234567_1
+  - libstdcxx-ng=11.2.0=h1234567_1
+  - libuuid=1.41.5=h5eee18b_0
+  - ncurses=6.4=h6a678d5_0
+  - openssl=3.0.15=h5eee18b_0
+  - pip=25.0=py310h06a4308_0
+  - python=3.10.12=h955ad1f_0
+  - readline=8.2=h5eee18b_0
+  - setuptools=75.8.0=py310h06a4308_0
+  - sqlite=3.45.3=h5eee18b_0
+  - tk=8.6.14=h39e8969_0
+  - tzdata=2025a=h04d1e81_0
+  - wheel=0.45.1=py310h06a4308_0
+  - xz=5.4.6=h5eee18b_1
+  - zlib=1.2.13=h5eee18b_1
+  - pip:
+      - altgraph==0.17.4
+      - blinker==1.9.0
+      - click==8.1.8
+      - flask==3.1.0
+      - flask-cors==5.0.0
+      - itsdangerous==2.2.0
+      - jinja2==3.1.5
+      - markupsafe==3.0.2
+      - numpy==2.2.2
+      - packaging==24.2
+      - pillow==11.1.0
+      - pyinstaller==6.11.1
+      - pyinstaller-hooks-contrib==2025.1
+      - scipy==1.15.1
+      - werkzeug==3.1.3
+prefix: /home/dustella/miniconda3/envs/vertex
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..f1156e4
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,44 @@
+# Project Vertex - Backend
+
+The name `Vertex` is a misspell of word `vortex` (漩涡). But I just leave all the naming wrong as `Vertex`, it means `顶点`
+
+## Project Setup
+
+Ensure you have Miniconda or Anaconda installed on your machine, and is using a modern version of windows or linux.
+
+The following command will install all the dependencies. Notice now we only have linux environment config, you need to manually install depds on windows.
+
+```bash
+conda create --name vertex -f ./env-linux.yml
+conda activate vertex
+```
+
+After that, you can start the development server by running the following command.
+
+```bash
+python ./backend.py
+```
+
+By default it runs on 35000. Use `VERTEX_PORT` to specify the port.
+
+```bash
+VERTEX_PORT=8080 python ./backend.py
+```
+
+To build the project, run the following command.
+
+```bash
+pyinstaller ./backend.py 
+```
+
+That will generate a `dist` folder, and you can find the executable file in the folder.
+
+## Project Structure
+
+WIP
+
+## Author
+
+By Dustella Chan (Hanwen Yu), distributed at my gitea server only.
+
+Contact me at `dustella@yeah.net`