chore: Update README
Signed-off-by: SindreKjelsrud <sindre@kjelsrud.dev>
This commit is contained in:
parent
b55b2d5ade
commit
fb7a45af9b
1 changed files with 46 additions and 32 deletions
78
README.md
78
README.md
|
@ -1,50 +1,64 @@
|
||||||
# Welcome to your Expo app 👋
|
# Minecraft Tools ⛏️
|
||||||
|
|
||||||
This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
|
A mobile application built with Expo, providing essential tools for Minecraft players. This app includes a Nether portal calculator, a to-do list, a coordinate saver, and an MOTD creator.
|
||||||
|
|
||||||
## Get started
|
## Features ✨
|
||||||
|
|
||||||
1. Install dependencies
|
* **Nether Portal Calculator:** Calculate precise Nether portal coordinates based on Overworld locations.
|
||||||
|
* **To-Do List:** Manage in-game tasks and objectives.
|
||||||
|
* **Coordinate Saver:** Save and retrieve important in-game coordinates with custom names.
|
||||||
|
* **MOTD Creator:** Generate formatted Messages of the Day for Minecraft servers.
|
||||||
|
|
||||||
```bash
|
## Installation 🚀
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Start the app
|
To get started with Minecraft Tools, follow these steps:
|
||||||
|
|
||||||
```bash
|
### Prerequisites ✅
|
||||||
npx expo start
|
|
||||||
```
|
|
||||||
|
|
||||||
In the output, you'll find options to open the app in a
|
Ensure you have Node.js and npm installed on your system. If not, download and install them from the official Node.js website: [https://nodejs.org/](https://nodejs.org/).
|
||||||
|
|
||||||
- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
|
### Steps 🪜
|
||||||
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
|
|
||||||
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
|
|
||||||
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo
|
|
||||||
|
|
||||||
You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
|
1. **Clone the repository:**
|
||||||
|
|
||||||
## Get a fresh project
|
```bash
|
||||||
|
git clone https://code.kjelsrud.dev/sidski/minecraft-tools.git
|
||||||
|
```
|
||||||
|
|
||||||
When you're ready, run:
|
2. **Navigate to the project directory:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd minecraft-tools
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Install dependencies:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **Start the application:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx expo start
|
||||||
|
```
|
||||||
|
|
||||||
|
This command will provide options to open the app in a development build, Android emulator, iOS simulator, or Expo Go.
|
||||||
|
|
||||||
|
## Development 🛠️
|
||||||
|
|
||||||
|
The project uses file-based routing. You can start developing by editing the files inside the `app` directory.
|
||||||
|
|
||||||
|
### Reset Project 🧹
|
||||||
|
|
||||||
|
To reset the project to a blank state, run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run reset-project
|
npm run reset-project
|
||||||
```
|
```
|
||||||
|
|
||||||
This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.
|
This command moves the starter code to the `app-example` directory and creates a blank `app` directory.
|
||||||
|
|
||||||
## Learn more
|
## License 📜
|
||||||
|
|
||||||
To learn more about developing your project with Expo, look at the following resources:
|
This project is licensed under the [MIT License](LICENSE).
|
||||||
|
|
||||||
- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
|
|
||||||
- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.
|
|
||||||
|
|
||||||
## Join the community
|
|
||||||
|
|
||||||
Join our community of developers creating universal apps.
|
|
||||||
|
|
||||||
- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute.
|
|
||||||
- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions.
|
|
Loading…
Add table
Reference in a new issue