Re-order the document (#294)

Signed-off-by: Aisuko <[email protected]>

README.md

@@ -27,17 +27,37 @@ https://github.com/SkywardAI/kirin/assets/8053949/143b016c-2264-4644-a7ae-304c90
      - [ ] Train the neural network with the given dataset  
      - [ ] Quantize the model and upload it to the server with the given tokens  
      - [ ] Visualize the neural network and the training process
-
+
+
 # Requirements
 
-See [Requirements.md](./docs/Requirements.md)
+You need to make sure Docker and docker-compose on your environment. See [Requirements.md](./docs/Requirements.md)
 
 
 # Quick setup
 
+If you want to setup the project quickly, please follow the steps below:
+
+```
+git clone https://github.com/SkywardAI/kirin.git
+
+cd kirin
+
+make demo
+```
+
 See [quick start](https://skywardai.github.io/skywardai.io/docs/quick-start.html)
 
 
+# Build and deployment
+
+<!-- https://stackoverflow.com/questions/2068344/how-do-i-get-a-youtube-video-thumbnail-from-the-youtube-api -->
+
+[![Build and Deployment](https://img.youtube.com/vi/63OxSmcBkhI/0.jpg)](https://youtu.be/63OxSmcBkhI?si=G82BOtcwRvQE7dLU)
+
+Also See [deployment](https://skywardai.github.io/skywardai.io/docs/development/build_and_run.html). And if you are interested in docker-in-docker development, see [Development.md](./docs/Development.md)
+
+
 # Tech stack
 
 This is a repository is the API aggregator of SkywardAI. It's using the following tech stack:
@@ -72,15 +92,6 @@ The above-listed technologies are just the main ones. There are other technologi
 * [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) $\rightarrow$ A file for distributing the responsibilities in our project to each team/teammate.
 
 
-# Build and deployment
-
-<!-- https://stackoverflow.com/questions/2068344/how-do-i-get-a-youtube-video-thumbnail-from-the-youtube-api -->
-
-[![Build and Deployment](https://img.youtube.com/vi/63OxSmcBkhI/0.jpg)](https://youtu.be/63OxSmcBkhI?si=G82BOtcwRvQE7dLU)
-
-Also See [deployment](https://skywardai.github.io/skywardai.io/docs/development/build_and_run.html). And if you are interested in docker-in-docker development, see [Development.md](./docs/Development.md)
-
-
 ## Acknowledgements
 
 * [FastAPI](https://fastapi.tiangolo.com/)

docs/Development.md

@@ -21,7 +21,7 @@ For developer, we encourage you to use the following technologies. You can debug
 
 There are one step to start the development environment:
 
-. Open the project in VSCode and click on the `Reopen in Container` button.
+. Open the project in VSCode and click on the `Reopen in Container` button or open the current folder in a container.
 
 And VSCode will automatically build the development environment based on our [pre-build images](https://hub.docker.com/r/gclub/skywardai/tags).
 

docs/Requirements.md

@@ -44,11 +44,3 @@ ubuntu:~/workspace/aisuko/kirin$ docker compose version
 Docker Compose version 2.24.6+ds1-0ubuntu1~22.04.1
 ```
 
-## Python 3.11
-
-
-```bash
-pip3 install -r https://raw.githubusercontent.com/SkywardAI/containers/main/requirements.txt
-```
-
-If you are interested in docker-in-docker devlopment, see [Development.md](./Development.md)