Add a minimal README #218

Merged
a3thakra merged 1 commits from adi-basic-readme into main 1 year ago
Collaborator
- #128
a3thakra added 1 commit 1 year ago
a72670fcc0 Add a minimal README
a3thakra requested review from n3parikh 1 year ago
a258wang reviewed 1 year ago
- `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)
Owner

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.
Poster
Collaborator

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.
a258wang approved these changes 1 year ago
a258wang left a comment
Owner

Overall, it looks good! I like the straightforward instructions and explanation of each command.

Overall, it looks good! I like the straightforward instructions and explanation of each command.
a3thakra merged commit a8337cbe5e into main 1 year ago
a3thakra referenced this issue from a commit 1 year ago
a3thakra deleted branch adi-basic-readme 1 year ago

Reviewers

n3parikh was requested for review 1 year ago
a258wang approved these changes 1 year ago
continuous-integration/drone/push Build is passing
The pull request has been merged as a8337cbe5e.
Sign in to join this conversation.
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date

No due date set.

Dependencies

No dependencies set.

Reference: www/www-new#218
Loading…
There is no content yet.