Add a minimal README #218
Merged
a3thakra
merged 1 commits from adi-basic-readme into main 1 year ago
n3parikh
a258wang
Loading…
Reference in new issue
There is no content yet.
Delete Branch 'adi-basic-readme'
Deleting a branch is permanent. It CANNOT be undone. Continue?
- `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)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.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.
Overall, it looks good! I like the straightforward instructions and explanation of each command.
a8337cbe5einto main 1 year agoReviewers
a8337cbe5e.