Update README with new instructions. #12
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clee231
requested changes
Feb 17, 2025
README.md
Outdated
Comment on lines
23
to
44
| ## Installation | ||
| This will produce a symlink called "result" in your local directory. The program | ||
| can be run as follows: | ||
|
|
||
| These steps seem to require python2, which does not ship with most linux distributions and is sunset. Therefore, it is recommended to run this app through docker instead (though of course, vulnerability will still exist - they will just be constrained to the container). | ||
| 1. Clone the repository. | ||
| 2. Navigate to the repository directory. | ||
| 3. Create a `.env` file based on `.env.example`. | ||
| 4. Run `npm install` to install dependencies. | ||
|
|
||
| ## How to use | ||
|
|
||
| 1. Run `npm run start` to start the npm server or `npm run watch` to watch for changes. | ||
| 2. Navigate the browser to `locahost:8080` or the port specified in the `.env` config. | ||
|
|
||
| ## Offline Mode | ||
|
|
||
| Offline mode will disable api requests to the server leaving only the clock running. It can be activated by going to `/offline` path. | ||
|
|
||
| ## Demo Mode | ||
| Demo mode works like offline mode but displays demo information instead of real data from apis. It can be activated by going to `/demo` path. | ||
|
|
||
| ## Configuration | ||
| To override the default config, you can use the URL GET parameters or by pressing `c` to open the config options. |
There was a problem hiding this comment.
I feel like these details about the application itself is still kinda useful to know about. Can we keep this and perhaps rename this section. It's not really installation details. It's more like application usage details or something like that?
There was a problem hiding this comment.
Hmm okay. Though it no longer needs python2
|
@clee231 Please can you take a look again |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.