Add a minimal README #218

a3thakra · 2021-08-28T23:02:50-04:00

a3thakra commented

2021-08-28 23:02:50 -04:00

#128

- #128

a3thakra added 1 commit 2021-08-28 23:02:51 -04:00

continuous-integration/drone/push Build is passing Details

a72670fcc0 Add a minimal README

- #128

a3thakra requested review from n3parikh 2021-08-28 23:03:14 -04:00

a258wang reviewed 2021-08-30 00:47:43 -04:00

README.md

													
				@ -0,0 +18,4 @@

				- `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)

a258wang commented

2021-08-30 00:47:43 -04:00

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.

a3thakra commented

2021-08-30 00:50:06 -04:00

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.