Add a minimal README #218

Merged
a3thakra merged 1 commits from adi-basic-readme into main 1 year ago
  1. 21
      README.md

@ -0,0 +1,21 @@
# Development
## Dependencies
Make sure that you have `node` >= 14 and `npm` >= 7. Node 14 ships with npm v6,
so if you're using node 14, you would need to upgrade npm. Alternatively you
could also upgrade to node 16, which ships with npm 7.
How to upgrade npm: `npm i -g npm`
## Local
- `npm install` to install project dependencies
- `npm run dev` to run the dev server (http://localhost:3000)
## Production
- `npm install` to install project dependencies
- `npm run build` to generate html/css/js
- `npm run export` to move the built files (along with assets in the public directory) to the `/out` directory
- Use your favourite web server to host the files in the `/out` directory. (A very simple one would be `python -m http.server` - not sure if it should actually be used for production :P)
Review

The :P) looks a little strange, in my opinion. (It is difficult to put an emoticon at the end of a sentence that is enclosed in brackets.) I'm also not sure how "professional"/formal our README should be.

The `:P)` looks a little strange, in my opinion. (It is difficult to put an emoticon at the end of a sentence that is enclosed in brackets.) I'm also not sure how "professional"/formal our README should be.
Review

It's fine for now, we will be updating it by the end of September! IMO it can have some informal bits as long as things make sense.

It's fine for now, we will be updating it by the end of September! IMO it can have some informal bits as long as things make sense.
Loading…
Cancel
Save