Create README

README.md

@@ -0,0 +1,81 @@
+# Guide
+
+`guide` is a website that summarizes actions by disaster, all maintained by the community
+
+## Features
+
+- The site is very lightweight
+- It is based on information from Japanese national institutions.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (version 20 or higher)
+- yarn (or yarn, although this project prefers yarn)
+
+### Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/evacuate/guide.git
+   ```
+
+2. Navigate to the project directory:
+
+   ```bash
+   cd guide
+   ```
+
+3. Install dependencies:
+
+   ```bash
+   yarn install
+   ```
+
+### Scripts
+
+- **Build**: Build the project
+
+  ```bash
+  yarn run build
+  ```
+
+- **Start**: Start the development server
+
+  ```bash
+  yarn run start
+  ```
+
+- **Format Code**: Format code
+
+  ```bash
+  yarn run format
+  ```
+
+- **Lint Code**: Lint code
+
+  ```bash
+  yarn run lint
+  ```
+
+### Usage
+
+1. Start the development server:
+
+   ```bash
+   yarn run start
+   ```
+
+2. Open the browser and navigate to `http://localhost:8080`
+
+## Author
+
+I proposed, facilitated, and developed the entire project.
+
+- Minagishl ([@minagishl](https://github.com/minagishl))
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.