From 4fc6a43f8cd5a612944eaf05108a972246788a98 Mon Sep 17 00:00:00 2001 From: Lawrence Zeng Date: Sat, 2 Nov 2024 21:29:30 -0400 Subject: [PATCH] Remove Maintainer's Guide (#232) Not relevant. --- README.md | 3 --- maintainer-guide.md | 53 --------------------------------------------- 2 files changed, 56 deletions(-) delete mode 100644 maintainer-guide.md diff --git a/README.md b/README.md index 3847d525..89db62f2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,2 @@ # diet-diary Keeping records of food you eat for the day. - ---- -Maintainer, please refer to [Maintainer's Guide](./maintainer-guide.md). \ No newline at end of file diff --git a/maintainer-guide.md b/maintainer-guide.md deleted file mode 100644 index c8e1c4f6..00000000 --- a/maintainer-guide.md +++ /dev/null @@ -1,53 +0,0 @@ -# Maintainer's Guide -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). - -## Available Scripts - -In the project directory, you can run: - -### Generate ANTLR JavaScript files -Generate parser for food description. You **must** run this script first before running `npm start`. - -```shell -export PATH="/usr/local/opt/openjdk@21/bin:$PATH" -npm run gen-parser -``` - -### `npm start` - -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.\ -You will also see any lint errors in the console. - -### `npm test` - -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 run build` - -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `npm run eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -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. - -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. - -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. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/).