readme

Author: zfletch

README.md

@@ -1,68 +1,53 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# Beta Code Converter
 
-## Available Scripts
+This is an interactive website for converting between Greek unicode and beta code.
 
-In the project directory, you can run:
+## Try it Out
 
-### `npm start`
+[https://apps.perseids.org/beta-code/](https://apps.perseids.org/beta-code/)
 
-Runs the app in the development mode.<br>
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+### How to Use
 
-The page will reload if you make edits.<br>
-You will also see any lint errors in the console.
+Type a word in one of the columns and it will convert it to the other format.
 
-### `npm test`
+### Beta code
 
-Launches the test runner in the interactive watch mode.<br>
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+Beta code is a system for encoding ancient Greek text using ASCII characters.
+For more information, see:
 
-### `npm run build`
+- [https://en.wikipedia.org/wiki/Beta\_Code](https://en.wikipedia.org/wiki/Beta_Code)
+- [http://www.tlg.uci.edu/encoding/](http://www.tlg.uci.edu/encoding/)
 
-Builds the app for production to the `build` folder.<br>
-It correctly bundles React in production mode and optimizes the build for the best performance.
+## Installation
 
-The build is minified and the filenames include the hashes.<br>
-Your app is ready to be deployed!
+`yarn install`
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+## Running the development server
 
-### `npm run eject`
+`yarn start`
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+## Building for deployment
 
-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.
+Before creating a production build you need to know the path where it will be accessed.
+Then run the command `PUBLIC_URL='./path/of/app' yarn build`.
+This will generate a set of static files in the `build/` directory that you can serve.
 
-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.
+For example, if you want to deploy it at `www.example.com/` then run `PUBLIC_URL='./' yarn build`.
+If you want to deploy it at `www.example.com/beta` then run
+`PUBLIC_URL='./beta' yarn build`.
 
-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.
+## Running tests
 
-## Learn More
+`yarn test`
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+## Linting the code
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+`yarn lint`
 
-### Code Splitting
+## Deploying a new version to github.io
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
+`yarn deploy-github`
 
-### Analyzing the Bundle Size
+## Deploying a new version to Perseids
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
-
-### Making a Progressive Web App
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
-
-### Advanced Configuration
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
-
-### Deployment
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
-
-### `npm run build` fails to minify
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
+`yarn deploy-perseids`