diff --git a/README.md b/README.md index b87cb00..b33ffda 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,58 @@ -# Getting Started with Create React App +# Gw2 PvP Pips Calculator -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +Desktop App to calculate how many PvP matches should be completed to reach a specific goal by the end of the season. -## Available Scripts +## Releases -In the project directory, you can run: +A link to the latest release can be found within github: [releases](https://github.com/voliva/gw2-pvp-pips/releases) -### `npm start` +## Technical details -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +Project built using [Tauri](https://tauri.app/), a framework that uses the OS' WebView to render a the front end (in React in this case, but it can be any other JS FE), which is orchestrated by a backend written in Rust. -The page will reload if you make edits.\ -You will also see any lint errors in the console. +Currently this project doesn't have any custom code on the BackEnd, all the logic is handled on the FE. -### `npm test` +### Run in dev: -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. +``` +> npm i +> npm run tauri dev +``` -### `npm run build` +While in dev you can open the webview devtools by using the platform's shortcut (e.g. F12 in windows) -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. +### Compile binaries: -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! +``` +npm run tauri build +``` -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. +The resulting executable should be in `src-tauri/target/release`, and the installer in `src-tauri/target/release/bundle` -### `npm run eject` +## License -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** +The application uses some of the official assets from ArenaNet, namely the background of the window, and the icons available through their official API (pips, chests). These are trademarked by ArenaNet and NCSoft. -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. +The code of this application is under MIT license: -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. +### MIT License -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. +Copyright (c) 2022 Víctor Oliva -## Learn More +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. -To learn React, check out the [React documentation](https://reactjs.org/). +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.